codesydney / codesydneywebsite

codesydneywebsite.vercel.app
10 stars 13 forks source link

Code Sydney Website

About this site

This is Code.Sydney's new website which everyone can contribute to, regardless of skill level. This is perfect for beginners who want to get exposed to working in a collaborative development environment.

Tech used

This is built on React.js and is deployed on Vercel

How do I contribute?

  1. Join the #project_codesydneywebsite Discord channel
  2. We have open issues that can be worked on in the Issues tab.
  3. You can see how these issues are progressing on our Kanban board.
  4. Visit our Code.Sydney Playbook here for a full guide

Setting up your machine for local development

Forking and Creating Your Branch

  1. How to fork this repository (https://github.com/firstcontributions/first-contributions)
  2. Copy code url from your forked version of project
  3. Avoid cloning directly from codesydney repo
  4. CD into directory on cmd terminal where you would like to store project files
  5. Finally enter following command to clone repo git clone [url]

Installing the Project

  1. If you are not using Node.js v14 install NVM by following (https://www.freecodecamp.org/news/node-version-manager-nvm-install-guide/)
  2. Make sure you are in codesydneywebsite project directory on your cmd terminal then type in folowing command:-
  3. Install the Node v14 using NVM with nvm install 14.
  4. Change to Node v14 using NVM with nvm use 14.
  5. Install the project dependencies with npm i.

Running the Project

  1. Change to Node v14 using NVM with nvm use 14.
  2. Run the Project with npm start.
  3. Access the site using your browser of choice via http://localhost:3000/

Happy coding!