Before getting started with development, please read through everything!
If you don't have yarn:
npm install --global yarnESLint allows us to keep our code consistent and adherent to a certain code style. It can also format our code on save in VSCode. To enable this (and please do), open the command palette in VSCode and open Preferences: Open Workspace Settings (JSON). Now add the following settings into the JSON file:
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
"eslint.validate": ["javascript"]Now when you save a file, VSCode will format it to adhere to our ESLint configuration.
Every component file in src/pages maps to a URL
E.g. src/aboutus.tsx -> https://hackdavis.io/aboutus
Components will all be located in /src/components
Stylesheets will be located in /src/styles
camelCase.tsx || camelCase.module.scss
camelCase only.
camelCase only.
camelCase.svg || camelCase.png
Branch names should be in the following format: group[1|2]-feature
Post your PRs to the technical-work channel on Slack and try to get at least 2 code reviews before merging the code.
This is a Next.js project bootstrapped with create-next-app.
Run the development server:
Install packages: yarn add
Run the dev server: yarn devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.