School Management REST API

This is the REST API application for school management system. This is build using Node JS, Express and MongoDB as the database service.

How to contribute

1. Fork the project into your local GitHub profile.:fork_and_knife:
2. Clone that project into your computer.:rocket:
3. Assign a issue from the issue tab. - All the issues are the features of the API.
4. Create new brach and called it with the respected feature.:seedling:

   For example: Issue - Create customer account Then you should name your brach like this. feature/student-account Brach name always should be simple letters.

5. Do your modifications to the code.👨‍💻
6. Commit changes to your local repository.💬
7. Create a pull request to upstream repository.:hand:

   Before create the pull request, please chack if there are merge conflicts in your code. If there are not conflicts, then create the Pull Request(PR)

8. Then you have to assign one or more team members to review your code.:eyes:

   After reviewing process are done and your code is ready to merge, one of our organization member will merge your changes to the master branch.

Run the application using Docker compose

1. Install Docker and docker-compose into your local computer.
2. Navigate to the project folder using terminal.
3. Run docker-compose up command to run both API application and MongoDB image.

More imformation about the documentation will be update in future