Build (install dependencies)

yarn

Run

yarn start

Git / GitHub Contribution Guide:

1. Open up a console and change the current directory to wherever you want to clone the repository.
2. Clone the repository:

   git clone https://github.com/TheCometProject/Back-End.git

   • You might be asked to enter your GitHub username and password (or PAT).
3. Create your personal branch: (check Notes on naming conventions)

   git checkout -b yourBranchName

4. Make your modifications and commit your changes.
5. Push your changes to the remote repository in your personal branch:

   git push origin yourBranchName

6. Make a Pull Request to the main branch to pull your changes.
7. Once your PR is merged, switch back to the main branch, delete your old branch (both on GitHub and locally) and pull the new changes to your local main branch:

   git branch main
   git branch -d yourBranchName
   git pull origin main

8. If you want to make more changes, repeat from step 3.

Notes

• NEVER PUSH TO THE main BRANCH.
• When you make a PR, you have to wait for other people to review your changes before merging to the main branch.
• You don't reuse branches that have already been merged, that's why you delete them after your PR is merged.
• Your branch name should be like this:
  • YourName/feature_XYZ
  • YourName/bugfix-34
• You must create a branch for every feature or bug fix you create.