ugonnathelma / document-management Goto Github PK

Document Management System is a react redux application that allows users to create, track, manage and store documents.

• Mocha
• Webpack
• React Redux
• Travic CI
• Coveralls
• Hound CI
• HTML/CSS
• Sequelize
• Express

• Clone the repository.
• Install dependencies
• Create a new branch for included feature(s) using the keyword feature/ example feature/new-feature.
• Raise a pull request.

Users are authenticated and validated using JWT tokens.

• Create an account
• Login with your credentials
• Create new document with specifying document title, content and document access
• Edit Documents
• Delete documents
• View public documents created by other users.
• View documents created by his access group with access level set as role.
• Search a users public documents.
• View public and role access level documents of other regular users.
• Logout

• In addition to the general user functions, an admin user can:
  • View all users.
  • View all created documents except documents with access set to private.
  • Delete any user.
  • Update any user's record.
  • Create a new role.
  • View all created roles.
  • Search for any user.

• Install NodeJs and Postgres on your machine
• Clone the repository $ git clone https://github.com/andela-uofoegbu/document-management.git
• Change into the directory $ cd /DocManagement
• Install all required dependencies with $ npm install
• Create a .env file in your root directory

• Migrate your database by running this command sequelize db:migrate:all
• Seed your database by running this command npm run db:seed:all, this seeds admin and regular roles, and superadmin user.
• Run npm run start:dev to start the application on development environment

• Run Test npm test
• You can undo your migrations by running this command npm run db:migrate:test:undo.

I strongly suggest using separate DB for testing and development

The API has routes, each dedicated to a single task that uses HTTP response codes to indicate API status and errors.

The following features make up the Document Management System API:

• It uses JSON Web Token (JWT) for authentication.

• It generates a token on successful login or account creation and returns it to the consumer.

• It verifies the token to ensures a user is authenticated to access protected endpoints.

• It allows users to be created.

• It allows users to login and obtain a token

• It allows the admin to manage users.

• It ensures roles can be created, retrieved, updated and deleted by an admin user.
• A non-admin user cannot create, retrieve, modify, or delete roles.
• it allows for assignment of roles to users

• It allows new documents to be created by authenticated users.

• It ensures all documents are accessible based on the permission specified.

• It allows admin users to create, retrieve, modify, and delete documents.

• It ensures users can delete, edit and update documents that they own.

• It allows users to retrieve all documents they own as well as public documents.

• It allows users to search public documents and documents they own for a specified search term.

• It allows admin to retrieve all documents that matches search term.

• It allows admin to search users based on a specified search term