/react-repo

React start

Primary LanguageJavaScript

Build Status Code Climate Coverage Status

Document-Management-System

This is a system (API) that manages documents with users and user roles. Each document defines access rights; the document defines which roles can access it. Also, each document specifies the date it was published. It is built with NodeJS, Express and Postgres as it's database. Source code employs ES6 syntax traspiled down to ES5 using Babel.

Key Application Features

A created user will have a role: admin, regular.

  • Regular, rated/restricted Users can:

    • Create an account
    • Login
    • Create a document
    • Limit access to a document by specifying an access group i.e. public, private or role.
    • View public documents created by other users.
    • View documents created by their access group with access level set as role.
    • Edit already created 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.
    • Delete any user.
    • Update any user's records.
    • Create a new role.
    • View all created roles.
    • Delete created roles aside the default roles admin and regular

Documents: Documents can be created and must have:

  • title
  • content
  • access; set by default to public but can be any of private, public or role

Authentication: Users are authenticated and validated using JSON web token (JWT). By generating a token on registration and login, API endpoints and documents are protected from unauthorised access. Requests to protected routes are validated using the generated token.

Development

This application was developed using NodeJs with express for routing. Postgres was used for persisting data with Sequelize as ORM.

The frontend was built with the react and redux framework.

Installation

  • Clone the project repository.
  • Run git clone https://github.com/treezy254/Document-Management-System.git.
  • Change directory into the Intranet directory.
  • Run npm install to install the dependencies in the package.json file.
  • Use Postman or any API testing tool of your choice to access the endpoints.

Usage

  • Run DB migrate commmand with sequelize db:migrate.
  • Run DB seeder command with sequelize db:seed to seed initial data into your DB.
  • Start the app with $ npm start
  • Login, Sign Up and start creating Documents once the app opens up on the browser

Endpoints

Here's the collection of routes. They can be checked out on Postman Run in Postman

It should be noted that the endpoints for roles here are only available to the Admin.

Technologies Used

  • JavaScript (ES6)
  • Node.js
  • Express
  • Postgresql
  • React/Redux
  • Sequelize ORM.
  • ReactJS with the Redux
  • Material Design CSS Framework
  • SASS/SCSS.

Contributing

  1. Fork this repositry to your account.
  2. Clone your repositry: git clone https://github.com/treezy254/Document-Management-System.git
  3. Create your feature branch: git checkout -b new-feature
  4. Commit your changes: git commit -m "did something"
  5. Push to the remote branch: git push origin new-feature
  6. Open a pull request.

Licence

ISC

Copyright (c) 2023 Kamau Samuel