README.md

Audioquorum-Website

MERN Project for Audioquorum website

Contribution Guidelines

1. Fork this repo
2. Clone your forked repo git clone
3. Add the main repo as upstream git remote add upstream {url}
4. Make your changes and push to your(forked) repo.
5. Create a pull request from github to main repo.

To get some changes from main repo git pull upstream

NOBODY SHOULD DIRECTLY PUSH TO THE MAIN REPO.

There will be 3 branches

• main
• frontend
• backend

Apart from the 3 branches above you can create as many branches as you want.

NOBODY SHOULD MAKE PULL REQUEST TO MAIN BRANCH. All changes should be made to either frontend or backend depending on where you are working.

Folder structure

 |- backend (Stores all the files regarding the backend of the project)
 |- frontend (Stores all the files regarding the frontend of the project)

Important Notes

• Commits and pull requests should be made with proper descriptive messages.
• Do NOT commit or push any sensitive info such as passwords or emails in the code. Such data should go in the .env file, and a sample empty entry for the same should be added for the same in .env.example
• Make sure to check before you are pushing the changes to the branch