Document Mangement System

Background Information

Document management system is an application used to track, manage and store documents.

Features

• Users can sign up/ log into the application
• Regular Users see a dashboard upon sign up/ login where they can
  • Create documents
    • Documents have different access levels (public, private and role).
  • Edit documents
  • Delete documents
  • View their documents
  • View other users documents on public or role access
  • Search for documents
  • Search for users
• Admin users from their dashboard can
  • View all users
  • View all public documents
  • Delete any user
  • Create new roles
  • Update users records
  • View all created roles
  • Search for users
  • Search for documents

Why is this project useful

• It enables proper and easy management, distribution and protection of documents.

How users can get started with the project

• By clicking on the Production app

Dependencies

• Node js is a JavaScript runtime built on Chrome's V8 JavaScript engine.
• Materialize css makes styling responsive web pages faster and easier.
• Mochais a feature-rich JavaScript test framework running on Node.js and in the browser used for asynchronous testing.
• Chai is a BDD / TDD assertion library for node and the browser that can be paired with any javascript testing framework.
• Istanbul Istanbul instruments your ES5 and ES2015+ JavaScript code with line counters, so that you can track how well your unit-tests exercise your codebase.
• Eslint provides a pluggable linting utility for JavaScript.
• Hound CI comments on style violations in GitHub pull requests.
• Travis CI a hosted continuous integration and delivery service for GitHub projects.
• Express js handles backend routing.
• Nodemonmonitors any changes in your source and restarts the browser.
• Coveralls shows the parts of your code that are not covered by your test suite.
• Sequelize Sequelize is a promise-based ORM for Node.js and io.js. It supports the dialects PostgreSQL, MySQL, MariaDB, SQLite and MSSQL and features solid transaction support, relations, read replication and more.
• PostgreSQL A powerful, open source object-relational database system.
• React A Javascript library for building user interfaces.
• Redux A predictable state container for JavaScript apps.

Installation and Setup

• Navigate to directory of choice on terminal.

• Clone this repository on that directory.

  • Using SSH;

    git clone [email protected]:Andela-ddiei/Document-management-system.git

  • Using HTTP;

    https://github.com/Andela-ddiei/Document-management-system.git

• Navigate to the repo's folder on your computer.

  cd document-management-system/

• Ensure you have Node.js installed.

• Install the app's dependencies using npm.

  npm install

• Start the application.

  npm start

• This launches the app on your default browser

How to run tests

• In your terminal, run

  npm test

API Documentation

• Api documentation

Limitations of the project

N/A

Contributing to the project

• Fork this repository to your account.
• Clone this repository: git clone https://github.com/andela-ddiei/Document-Management-System.git
• Create a feature branch: git checkout -b new-branch
• Commit your changes: git commit -m "commit message"
• Push to the remote branch: git push origin new-branch
• Create a pull request.

Troubleshooting and FAQ

https://github.com/andela-ddiei/Document-management-system/issues