Skip to content

A document management system RESTful API to implement CRUD for users, documents, and roles

License

Notifications You must be signed in to change notification settings

rowlandekemezie/Document-Manager-REST-API

Repository files navigation

Travis Ci Code Climate js-standard-style Coveralls

Document-Manager-REST-API

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.

Installation

  1. Download and install Node JS if not already installed.
  2. Download and install Mongodb if not already installed.
  3. Clone the repository here or go to the project github page here and download the zip file of the project. Unzip it.
  4. Navigate to your terminal and change your directory to the Document-Manager-REST-API.
  5. Run npm install to install node dependencies.

Usage

Run npm start on your terminal. Navigate to http://localhost:5555 on your browser.

Test

Run npm test on your terminal. Remember to run test on the project root directory.

Contributing

  1. Create an issue. First look through the open issues.
  2. Clone the repository or fork it.
  3. Create your feature branch: git checkout -b my-new-feature
  4. Commit your changes: git commit -m 'Add some feature'
  5. Push to the branch: git push origin your-new-feature
  6. Submit a pull request.

Links

About

A document management system RESTful API to implement CRUD for users, documents, and roles

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published