Docman is document management api which is used to track and managements documents based on roles and priviledges It Features an Administator that has access to all documents and users.
- Users can view documents based on priviledges
- Users can search for documents
- Users can create document and specify the access level
- Users can edit documents
- Users can edit documents
- Admins can get a list of all users and all documents
Please click here to view the api's documentation
To run this Api locally ensure you have the following dependcies on your computer
- Node - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
- Npm - Node package Manager
- postgres - PostgreSQL is a powerful, open source object-relational database system
- Any
RESTApi client
Production and development dependencies are listed in the package.json file
- clone the project to your local machine, copy and paste the commands below on your terminal
$ git clone https://github.com/seyi-adeleke/docman.git
-install dependencies
$ npm install
-start the project
$ npm run start:dev
-
The tests have been written using Gulp-Jasmine and Chai.
-To run tests use the command
$ npm test
Contibutions to Docman are welcome. Fork this Repo and submit a pull request with the pr message explaining your changes.Ensure it is fully tested and you extend the airbnb style guide
A link to the api is provided here
All Api endpoints are restful
The API currently returns data in JSON format.
All api endpoints require authentication and authorization. On succesfull login or signup a token is returned. Set the token as the value to the Authorization key in your headers.
The api uses a shared database connection thereby leading to occasionally slow response times
This project has three environments configured all with their own databases
- Development
- Test
- Production
This describes my local devlopment environment with certain configurations that make the workflow easier. It's designed to simulate a production environment as closely as possible but it is configured to work with dummy data
The test environment is used to run the integration and unit tests for this application, it is completely seperate and it has its own migrations and seeders. For this project the test environment is configured on TRAVIS CI.
This is the live environment that contains real data. Currently, it is hosted on Heroku.
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Adeleke Adetokunbo