Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.09 KB

README.md

File metadata and controls

24 lines (17 loc) · 1.09 KB
Raw

CSES Web Dev Set Up Guide

  1. Download Node and npm if you don't have them (run node -v and npm -v to check).
  2. Clone the repository on the main branch and open the project in VSCode.
  3. Install VSCode extensions Eslint and Prettier (for linting and formatting).

FrontEnd

  1. Go to the project/frontend directory.
  2. Run npm install to install all the node packages.
  3. Run npm start to run the React App and check if you can see the rendered site at http://localhost:3000/

BackEnd

  1. Go to the project/backend directory.
  2. Run npm install to install all the node packages.
  3. Run npm start to start the backend server and check there is no error in the terminal.
  4. Make a copy of the .env.example file and rename it .env.

Development

  • Prior to any local development, you should pull the latest code from main and work on your separate branch.
  • Your branch name should be in the format: (feature/bug)/github_username/(FE/BE)-feature_name.
  • An example of a good branch name: feature/Will-Hsu/FE-Buttons or bug/Will-Hsu/FE-ButtonsDebug.