GroupCollaborationTool
A WeDev Atlanta Meetup project. A tool for collaboration, that's being built through collaboration. Neat!
Here's how to get started:
Get a copy of this repo
-
Fork this respository by clicking here.
-
Clone the forked copy to your computer:
git clone https://gthub.com/<your-user-name>/GroupCollaborationTool.git
- Add an upstream to the shared repo:
cd GroupCollaborationTool
git remote add upstream https://github.com/webdevatlanta/GroupCollaborationTool.git
Making your contribution
- Always start off by fetching and merging the latest changes:
git checkout master
git fetch --all
git merge upstream/master
- Install/update dependencies
yarn install
- Create a feature branch based off master:
git checkout -B my_feature_branch_name_here
- Start the dev server
yarn start
-
...make your edits, fix a bug, implement a feature, etc. If you're looking for something to work on, check out our Issues page.
-
Add, commit, and push your feature branch to your Github:
git add .
git commit -m "Enter your description of your changes."
git push origin my_feature_branch_name_here
-
Use your GitHub page to create a pull request from your feature branch to master.
-
One of the admins will then merge your changes into the main branch.
-
Return to step 1 and repeat: fetch, merge, branch, edit, commit, push!
Running tests
- Install Firebase/Firestore emulators (only need to do this once)
npx firebase setup:emulators:firestore
- Start the Firestore emulator:
npx firebase emulators:start --only firestore
- Run the React test script:
yarn test