Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.33 KB

README.md

File metadata and controls

76 lines (57 loc) · 2.33 KB
Raw

Documents App

Build Status codecov Code Climate Dependency Status

Deploy

Document management app.

Deploying locally

Prerequisites

Installing

Clone the repo

git clone https://github.com/andela-hthuo/documents-app.git

Install npm dependencies

Make sure the project directory your working directory if it isn't already.

cd documents-app

Install the dependencies

npm install

Running the server

Start the MongoDB server if you don't have it running.

mongod

Export/set environment variables

The environment variables used by the server are:

  • MONGODB_URI
  • NODE_ENV
  • PORT
  • SECRET_KEY
  • ADMIN_EMAIL
  • ADMIN_PASSWORD

NOTE: All these variables have defaults but it's highly recommended to set your own SECRET_KEY and ADMIN_PASSWORD because these should not be public while their defaults have been checked into source control.

Start the server

Start the development server.

npm run start-dev

Alternatively, start the production server.

npm start

NOTE: Make sure the project directory your working directory before starting the server.

Using the app

Open http://http://localhost:3000. You can run the app in a different port by setting the PORT environment variable.

NOTE: A default admin user is created with the email in ADMIN_EMAIL and the password ADMIN_PASSWORD environment variables.

The API

API documentation

LICENSE

MIT