Skip to main content

setup

Prerequisites​

Windows​

  • Windows Terminal: This is used to navigate through the project/repo and to run the development server.
  • Ubuntu WSL (Recommended): This is to use the bash terminal found in Linux. I recommend using a WSL to use Linux commands for developing this project. Follow this guide to install

All OSes​

  • Install Git
  • Install Node.JS
  • Install Yarn
    • Run the following command to install: npm install --global yarn
  • Install a code editor of your choice (e.g VScode, Atom, Sublime, etc.)
  • Install at least two popular browsers (e.g. Chrome, Firefox, Safari, etc.). This is for testing for cross compatibility for different browsers

Setting Up Your Local Environment​

Run the following commands in a terminal

Forking​

Forking the repo to work on your own code

  • Fork the repo by clicking the Fork button in the upper right corner
    • This creates a copy of the repository in your own account

Clone the Project​

  • git clone <forked_repo_link>
  • cd citrushack2023
    • This is to navigate into the directory generated for the cloned repo
  • If you are using VScode, run code . to open the current directory in VScode (this is mainly for easier navigation)
    • You may need to install code so run sudo apt install code

Install Necessary Packages​

  • yarn or yarn install
    • This will install all necessary packages for the project

Run the Development Server​

  • yarn dev
  • Go to http://localhost:3000/
    • This is the port where the development server is run on. Any changes you make to the code will reflect almost instantly while the server is running