Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 3.48 KB

README.md

File metadata and controls

58 lines (44 loc) · 3.48 KB
Raw

dman

dman is a full stack document management system which uses roles and priviledges to categorize documents. To access any document you must have access rights and you must have a role. The document are also arranged based on date created.

Code Climate Travis Build Coverage Status

Introduction

dman is a full stack document management system which uses roles and priviledges to categorize documents. To access any document you must have access rights and you must have a role. The documents are also arranged based on date created.

Dependencies

  • Node JS - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Postgresql -
  • Express - Express is a minimal and flexible Node.js web application framework, It is used as the web server.
  • Gulp - Gulp is a task runner which helps in automating time-consuming tasks in your development workflow.
  • Sequelize - Sequelize is a promise-based Node.js ORM for Postgres, MySQL, SQLite and Microsoft SQL Server. It features solid transaction support, relations, read replication and more
  • jsonwebtoken - It was used for user authriaztion and authentication
  • supertest - Supertest is a framework used in testing API endpoints

Features

  • Users can view documents based on access rights
  • Users can search for documents based on access rights
  • Users can create documents and specify rights
  • Users can edit document based on priviledges and access rights
  • Users can delete documents
  • Admin Users can create users
  • Admin Users can delete any user's profile

Getting started with the project

  • Visit the Wiki to find out how to make use of this project.

API Documentation

The API has routes, each dedicated to a single task that uses HTTP response codes to indicate request success or errors. The full documentation can be found here

Naming conventions

  • Visit the Wiki to find branch, commit messages and pull request naming conventions.

Contributing to the project

  • Fork this repository to your github account
  • Clone the repository - git clone https://github.com/vynessa/dman.git
  • Create your feature branch - git checkout -b your-branch-name
  • Commit your changes - git commit -m “[Enter message]“ or git commit for the interactive interface
  • Push to the remote branch - git push origin your-branch-name
  • Open a pull request (See wiki for pull request(s) naming convention)

Click this link to visit the hosted app dman

I look forward to your pull requests :)

License

MIT License

Author