Giter VIP home page Giter VIP logo

document-manager's Introduction

document-manager

Code Climate Issue Count Coverage Status Build Status

document-management

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

Application Features

User Authentication

Users are authenticated and validated using JWT tokens.

Document Management

  • 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.

Technologies and Services

Written in Javascript es6 syntax and nodejs on the backend, with the following:

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

Contributions

  • 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.

Installation

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

Usage

  • 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 start to start the application on development environment

Testing

  • Run Test npm test
  • You can undo your migrations by running this command sequelize db:migrate:undo:all .
  • I strongly suggest using separate DB for testing and development
Available API Endpoints and their Functionality

Api documentation

document-manager's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.