document-management-system

The Document Management System API contains several API end points that allow users to create, edit, retrieve and delete documents. In addition, it contains API end points that allow the management of users i.e. create, edit, retrieve, delete users. Users can also have roles assigned to them with.

Find the Documentation Here

Development

1. NodeJS
2. Express
3. Postgres
4. Sequelize
5. ReactJS

Installation

1. Install NodeJS and Postgres
2. Clone the repository https://github.com/andela-tAdedotun/document-management-system
3. Change your directory cd document-management-system
4. Install all dependencies npm install
5. Run tests npm test
6. Run integration test npm run e2e
7. Start the app in production mode: npm start or development mode: npm run start:dev
8. Use Postman to test the API endpoints.

Features

The Document Management System app spots the following features:

1. A markdown editor for creating and editing documents.
2. A homepage spotting a user's personal documents.
3. A separate dashboard for admins and regular users.
4. Ability to explore and view other people's documents.
5. Search that cuts across the whole platform.

NB: All these features are available only to authenticated users.

Contribute

1. Fork this repository
2. Clone it to your local machine
3. Create a branch for the feature you want to implement
4. Push your changes to your repository
5. Submit a pull request

Limitations:

1. Currently, as a regular user, you cannot search for other users and view their documents. It's something that will be addressed in future releases.
2. Unauthenticated users cannot view public documents.
3. You cannot view other people's documents by clicking on their profile names.

Issue Tracker:

https://github.com/andela-tAdedotun/document-management-system/issues