- You have Node 14+ installed.
- You have mongodb's local instance installed
-
Fork this repository, click on the fork icon located on top-right side of this page, below your avatar
-
Clone that forked repository.
git clone https://github.com/[yourUsername]/buddies-tube.git buddies-tube
- Set up the upstream remote URL for referencing the original repository
git remote add upstream https://github.com/askbuddie/buddies-tube
- from the buddies-tube directory, install necessary dependencies
cd buddies-tube
yarn install # installs the base dependencies```
## The generic workflow
1. Pull the latest changes from the original repository (the upstream)
```bash
git pull upstream main
- Then, create a separate branch for every new feature/bug fix
git checkout -b [branchName] # eg. git checkout -b signup-feature
- Start the app(frontend+backend)
mongod # mongodb's local instance
yarn start # http://localhost:3000
- Do your change / Implement a new feature
- Don't forget to keep pushing your progress to the remote (your forked repository)
git add .
git commit -m "brief about your change..."
git push -u origin [branchName]
we recommend you to follow conventional commits instructions for writing commit messages. It's not mandatory though.
contact us if you have any problem
- Make sure all the test passes.
yarn test # should pass all the checks
- Create a pull request,
- Go to your forked repository on github,
- If there are no conflicts, you will see a button saying create a new Pull Request.
- Make sure to select the
develop
branch as your pull request target. - Click on that big green button.