Document-Manager-REST-API is a RESTful API built with Express, Node, and Mongodb. The application allows you to manage users, roles and documents with assigned authorization. Basically, it implements CRUD(Create-Read-Update-Delete) for User, Role, and Document models.
- Download and install Node JS if not already installed.
- Download and install Mongodb if not already installed.
- Clone the repository here or go to the project github page here and download the zip file of the project. Unzip it.
- Navigate to your terminal and change your directory to the Document-Manager-REST-API.
- Run
npm install
to install node dependencies.
Run npm start
on your terminal.
Navigate to http://localhost:5555
on your browser.
Run npm test
on your terminal. Remember to run test on the project root directory.
- Create an issue. First look through the open issues.
- Clone the repository or fork it.
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin your-new-feature
- Submit a pull request.