TLDR of the official documentation.
Everything starts in pages/_app.js
and pages/index.js
.
The production branch of this site is the main
branch. You are not to directly code and push to this branch, main
and dev
(I have anyway deactivated access to this branch).
When you are assigned a page, you need to create a branch that describes the page you are coding (eg. home-page). You need to create this branch from the dev
branch. After you are done with the code, pull the latest code from the dev
branch (since all the pushes done by your peers will be to that branch), resolve merge conflicts from the dev pull and then finally commit and push to your branch and create a pull request to dev branch.
Try to avoid in pages that other people are working on, it will not result in merge conflicts. Consult me if you need any help in resolving merge conflicts.
Each route ["/Home", "/Internships", etc]
has a different folder under pages. Under each folder we have the main page as index.js.
All reusable components are stored under src/Common
folder.
All constants such as primary and secondary color, route names are stored under src/Constants
.
Please note that the colors are defined as css variables under styles/globals.css
. Do not hard code any color as it may rain down hell on us in case we need to change the color scheme of the site. If you do see any hard coded css variable, do report it and change it on your own. In case the color you need to use is not mentioned in the globals.css file, bring it to my notice. We may either get the color changed in the design, if not you are free to add the color on your own.
The fonts are also mentioned in styles/globals.css
file and the rules similar to colors apply here.
The styles here are unique. The globals.css
file contains css that are followed throughout the website.
Page specific styles are written as Page.module.css
(eg. Home.module.css). The styles of common components go under styles/Common/Components.module.css
Please internalise these coding schemes so that we may have a wholesome development experience.
This is a Next.js project bootstrapped with create-next-app
.
First, run the development server:
npm run dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.js
. 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.js
.
The pages/api
directory is mapped to /api/*
. Files in this directory are treated as API routes instead of React pages.
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.