BUNK MANAGER

Tech-Stack

How To Run the Project

1. Open Project Folder

2. To install all dependencies open Command Prompt and run

npm i

3. To install all client dependencies open client folder and again run

npm i

4. To run the server-

npm run server

5. To run the client-

npm run client

6. To run both server and client- Recommended

npm run dev

To start contributing, follow the below guidelines:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone --depth 1 https://github.com/<your_user_name>/bunk-manager-mern.git

3. Navigate to the project directory 📁 .

cd bunk-manager-mern

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/ADRE9/bunk-manager-mern.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream master

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perform your desired changes to the code base.

9. Track your changes:heavy_check_mark: .

git add .

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

Contributor:

Credits goes to these people: ✨