- Download Node and npm if you don't have them (run
node -v
andnpm -v
to check). - Clone the repository on the
main
branch and open the project in VSCode. - Install VSCode extensions Eslint and Prettier (for linting and formatting).
- Go to the
project/frontend
directory. - Run
npm install
to install all the node packages. - Run
npm start
to run the React App and check if you can see the rendered site at http://localhost:3000/
- Go to the
project/backend
directory. - Run
npm install
to install all the node packages. - Run
npm start
to start the backend server and check there is no error in the terminal. - Make a copy of the
.env.example
file and rename it.env
.
- 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
orbug/Will-Hsu/FE-ButtonsDebug
.