README.md

Husky Coding Project Official Website

The the Husky Coding Project Official Website built with NextJS leveraging ChakraUI as our components library. Hosted with Vercel.

🛠 Installation & Set Up

1. Install Yarn

npm install --global yarn

2. Clone the website locally into ${HOME}

git clone https://github.com/hcp-uw/club-website.git

3. Go to ${HOME}/club-website/.

cd ${HOME}/club-website/

4. Install all dependencies using yarn (or yarn install)

yarn

Running the App Locally

yarn dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Linter

yarn lint

To apply fixes:

yarn lint --apply

To apply unsafe fixes:

yarn lint --apply-unsafe

Formatter

yarn fmt

For more information about Linter and Formatter, please visit https://docs.rome.tools/.

See the section about deployment for more information.

How to publish site

https://github.com/hcp-uw/club-website/blob/main/.github/workflows/publish.yml

$ git tag v2.0.0
$ git push origin v2.0.0

If you fail to deploy the site

Run the following commands after you fix the cause of failure:

# delete tag
$ git tag -d v2.0.0
$ git push origin :v2.0.0

# create a new tag
$ git tag v2.0.0
$ git push origin v2.0.0

This project exists thanks to all our contributors ❤️