https://github.com/kevgathuku/docue

Document Management System API Backend
https://github.com/kevgathuku/docue

Last synced: about 1 month ago
JSON representation

Document Management System API Backend

• Host: GitHub
• URL: https://github.com/kevgathuku/docue
• Owner: kevgathuku
• Archived: true
• Created: 2016-01-19T11:01:40.000Z (almost 9 years ago)
• Default Branch: develop
• Last Pushed: 2020-11-09T09:40:05.000Z (about 4 years ago)
• Last Synced: 2024-04-16T04:06:57.175Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 687 KB
• Stars: 9
• Watchers: 3
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-opensource-apps - docue

README

        
# Document Management System

[![Build Status](https://travis-ci.org/kevgathuku/docue.svg?branch=master)](https://travis-ci.org/kevgathuku/docue)   [![Coverage Status](https://coveralls.io/repos/github/kevgathuku/docue/badge.svg?branch=master)](https://coveralls.io/github/kevgathuku/docue?branch=master)

[View on Pivotal Tracker](https://www.pivotaltracker.com/n/projects/1515788)

The system manages documents, users and roles.

Each document defines access rights i.e. which roles can access it and the date it was published.

Users are categorized by roles. Each user must have a role defined for them.

## Installation

- Clone the repo locally and navigate to the newly created folder

    ```bash

    git clone https://github.com/kevgathuku/docue

  cd docue

    ```

 - Install the app dependencies

    ```bash

    npm install

    ```

 - Copy the `.env.example` file to `.env`

     ```bash

     cp .env.example .env

     ```

 - Replace the values in the `.env` file with the appropriate values

         - `PORT` - The port where you want the application to be run

         - `SECRET` - A hard to guess string that is used in encrypting the tokens

         - `MONGODB_URL` - The URL to your MongoDB Database

         - `NODE_ENV` - The environment you are running the code in i.e `development`, `test` or `production`

             The default value of `development` is fine and should work for most cases

 - Start the project by running

    ```bash

    npm start

    ```

  It can be accessed on `http://localhost:8000`

## Running tests

The tests are run using `jasmine` on the command line

To run the tests, use the following steps:

 - Navigate to the project folder

    `$ cd docue`

 - Run the tests through the following command:

    `$ npm test`