Awesome
Document Management System
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
git clone https://github.com/kevgathuku/docue cd docue
-
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 -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.edevelopment
,test
orproduction
The default value ofdevelopment
is fine and should work for most cases -
Start the project by running
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