Skip to content
This repository has been archived by the owner on Jun 30, 2019. It is now read-only.

kevgathuku/docue-frontend

Repository files navigation

Document Management System

Build Status Coverage Status

View on Pivotal Tracker

This is the frontend for a system that 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 backend repo first and follow the instructions in the README to get it up and running:
git clone https://github.com/kevgathuku/docue
  • Clone the frontend repo locally and navigate to the newly created folder

    git clone https://github.com/kevgathuku/docue-frontend
    cd docue-frontend
  • Install the app dependencies

    npm install
  • Copy the .env.example file to .env

    cp .env.example .env
  • Replace the values in the .env file with the appropriate values - 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

    npm start

    It can be accessed on http://localhost:3000

Running tests

To run the tests, use the following command:

npm test