Dev Environment Setup
- Docker
- Git
- ESLint extension in VSCode
-
Clone the repository In your VScode, open a bash terminal and paste the command 'git clone https://github.com/Garycheng92/PromptMail.git'
-
Docker Setup
In your root directory of your project, run the command 'docker-compose up --build'
In your browser, visit: http://localhost:3000/ and ensure you see the VITE + React logo, our local front end will be hosted on this port
Also visit: http://localhost:5000 and confirm you see a message that says 'Backend is running!' this will be our backend port for our local development
If you encounter any error or are finished developing for the day, Press CTRL + C a couple times in the bash terminal where the docker container is running. After exiting the container, paste the command 'docker-compose down -v'
Currently the only dependencies are react and nodejs, if there are any future libraries or tools needed, message the team and we can add it as a dependency to our docker container.
Any updates made to the front end or back end will automatically be rendered in the local environment.
For every new issue that is created, create a new branch that addresses that issue for example:
Click create a branch and the menu will appear:
Click create branch
In your IDE open a bash terminal and paste these commands:
git fetch origin
git checkout 'Your branch name'
The branch assigned to that issue will be named 7-test-base-case-api-calls
Once you completed your work for that issue, run the following commands:
git add .
git commit -m "Your commit message"
On your first commit you will run into this message:
Simply run the commands stated with your email for the first command and your name for the second
Once that's done run 'git push' Your work will be pushed for review
Navigate to https://github.com/Garycheng92/PromptMail/pulls and open a new pull request, a notification will be sent to #project-status in discord where someone on the team will review your code.
Once it is approved, merge into main