Code Monkey home page Code Monkey logo

tech-council-website's Introduction

Technical Council Wesbite 2022 | IIT Gandhinagar

TLDR of the official documentation.

Basic

Everything starts in pages/_app.js and pages/index.js.

Version Control

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.

Routes

Each route ["/Home", "/Internships", etc] has a different folder under pages. Under each folder we have the main page as index.js.

Commons and Constants

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.

Styles

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.

Getting Started

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.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.