- Download Node and npm if you don't have them (run
node -vandnpm -vto check). - Clone the repository on the
mainbranch and open the project in VSCode. - Install VSCode extensions Eslint and Prettier (for linting and formatting).
- Go to the
project/frontenddirectory. - Run
npm installto install all the node packages. - Run
npm startto run the React App and check if you can see the rendered site at http://localhost:3000/
- Go to the
project/backenddirectory. - Run
npm installto install all the node packages. - Run
npm startto start the backend server and check there is no error in the terminal. - Make a copy of the
.env.examplefile and rename it.env.
- Prior to any local development, you should pull the latest code from
mainand 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-Buttonsorbug/Will-Hsu/FE-ButtonsDebug.