V1 at Michigan

This is the code repository for the website. Serverless frontend built with Next.js + Tailwind CSS. Hosted on Netlify.

How to work on this Project

First clone the repository: git clone https://github.com/V1Michigan/v1.git.
Make sure you enter the repository through terminal cd <FilePath>/v1.
Install dependencies: yarn install. We DO NOT use npm for this.
Begin Devving: yarn dev. This will allow you to access a dev version of the site @ localhost:3000 that will update automatically as you save files.
Create a new branch for your NEW feature: git checkout -b [FEATURE_NAME]. If you want to go to an existing feature: git checkout [FEATURE_NAME].
Ask another team member for the latest .env file.
When you finish a part of your feature and wish to push the changes to the remote repository:
git add [changed_files] (replace changed_files with the actual file names you changed)
git commit -m "meaningful commit message goes here"
git push --set-upstream origin [FEATURE_NAME] (the next time you push to this branch you can just say git push).

We use ESLint + Prettier to lint our code and enforce consistent style. To make this process smoother, we've set up:

Pre-commit hooks: Automatically lint and format your code when you commit changes. This uses Husky and lint-staged to ensure code quality without disrupting your workflow.
Non-blocking CI: Our GitHub Actions workflow checks for linting issues but won't block builds due to formatting problems.

For manual linting:

We recommend using an ESLint plugin for your editor to lint and format your code as you write it.

See the CONTRIBUTING.md file for more detailed information about code standards and workflow.