Skip to content

Getting Started

Jump to bottom
skyheat edited this page Jun 27, 2022 · 2 revisions

First Steps

  1. We will be using Discord to communicate throughout the project, make sure you join the server in Discord and give a quick intro so we know who you are and what team you're in. Important information will still be sent to you via email.
  2. In order to keep track of work and assign tasks we will be using Github. We will be creating Github issues which represent pieces of work that need to be done. Ensure you have a Github account. Our committee will add you as contributor to the project repositories that you are working on.
  3. Install the relevant software listed below

Tools Check List

  • Git - Version control system.
  • Node - Used for building web applications
  • VSCode - Or any other preferred code editor/IDE.
  • Yarn - Package manager for Node application.

Check If Tools Are Installed Correctly From the command line, use these commands to check that the tools installed correctly yarn -v node -v git --version npm -v They should all return something, if not please reach out to our committee member (Again, we will check everybody got the environment ready for coding on our first project meeting day, so don't worry if you can't get it right for the moment)

Getting Started

First, install the dependencies:

yarn install

Then, run the development server:

yarn dev

Open 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.

Workflow

We will be breaking the project down into small chunks of work and creating a Github issue to keep track of each of them.

You will be assigned to a team of 3 to work on an issue together.

  1. Pick an issue and assign yourself or your team to it.

    This may be tough to do if you don't have a clear concept of the project so it's a great idea to ping your project manager or send a message in your teams discord channel if you need a new issue to work on.

  2. A branch will automatically be created for you.

  3. The name of the branch will be in this format:

i<issue-number>-<issue-name>
  1. For example, if the issue was:

    Create a navbar #2

  2. The branch name would be i2-create_a_navbar.
  3. The naming scheme for your pull request should be:
I<issue-number> <pr-name>

Eg. PR - I2 Created a navbar

  1. For a work in progress issue:
WIP I<issue-number> <pr-name>

Eg. PR - I2 Created a navbar 8. The issue should be automatically linked to your PR and will be closed once your PR is merged.

  1. Wait for the project manager or another dev to read do a code review.

    Everyone is welcome to contribute to this process and all comments will be public on Github. During the weekly meetups it may be a good idea to have the reviewer talk to you about the changes they requested as this is a good way to learn and clarify what needs to change.

  2. Once the changes and fixes have been made, your branch will be merged into the main branch and you'll be good to swap to a new issue.

This process may seem daunting at first but the key is repetition and perseverance.

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.

Clone this wiki locally