DocMe is 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.
- Users can view documents based on access rights
- Users can search for documents based on access rights
- Users can create document and specify rights
- User can edit document based on priviledges and access rights
- User can delete document
- Admin User can search for documents
- Admin user get list users by page
- User get list documents by page
Please click here to view endpoints documentaion
What you need to run this app:
- Node was used to run JavaScript code on the server. Please click here for installation guide
- pgAdmin - Open Source administration and development platform for PostgreSQL. Please click here for installation guide
- Postman A Chrome app that you can use to test our API locally. Please click here for installation guide
- Chai - Chai is used together with jasmine to test this application
- Express - Express is Node.js web application framework
- Gulp - Was used for task runner
- jsonwebtoken - It was used for user authriaztion and authentication
- sequelize - Used for ORMs database
- babel-cli - It enables the app scripts to be tested with babel from the command line
- eslint - This is a javascript syntax highlighter used to highligh syntax error during the development of this app
- gulp-nodemon - to watch the files in the directory for any files change
- supertest - to run endpoint test
- babel-core - It compiles es6 used in the app to es5
- babel-eslint - Used with ESlint to lint syntax errors
- Babel-register - This framework helps to compile from es6 to es5
- bcrypt - Used to hash user's password
- coveralls - Display test coverage
- dotenv - To protect secret ID
- path - to get paths during production
- clone the project to new folder, copy and paste the commands below on your terminal
$ git clone https://github.com/omedale/DOCME-CP2.git
-install dependencies
$ npm install
-start the project
$ npm start
-
The tests have been written using Gulp-Jasmine and Chai.
-
They are run using the
coveragetool in order to generate test coverage reports.-To run test
$ npm test
If you are planning on contributing to DocMe, that's great. I welcome contributions to DocMe. If the contribution you wish to make isn't documented in an existing issue, please create an issue, before you submit a Pull Request. This will allow me and Collaborators a chance to give additional feedback as well. Click here for more information on how to contribute.
No, its free for everyone.
You need to request a resource from one of the endpoints using HTTPS. Generally, reading any data is done through a request with GET method. If you want our server to create, update or delete a given resource, POST or PUT methods are required. Please click here for more information
DocMe APIs currently returns data in JSON format.
All endpints except login and signup are protected. Users requre token to access all protected endpoints. Token is sent to client after successful signup and login. Token must be set as authorization in the http request header to access the protected routes
The application uses shared database (Elephantsql), this may lead to slow in response at some point.
(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.
Oluwafemi Medale - @omedale