DocMan

Andela JavaScript Curriculum Checkpoint 4 - Document Manager.

Description

This is a simple web application that allows users to create accounts and manage simple documents. Document here is used with a grain of salt to mean any kind of object with a string title and a string body content.

It allows users to register and create such kinds of documents. Users can assign access permissions to documents, which will restrict that document's audience.

Installation

You can find this project hosted on Heroku at https://docman-cp4-staging.herokuapp.com

Alternatively, you can run it locally as follows:

First, make sure you have NodeJS and MongoDB installed, then:

1. Clone this repository

   $ git clone https://github.com/andela-jmuturi/docman-react-redux.git && cd docman-react-redux
   

2. Install the project's dependencies

   $ npm install
   

3. Ensure you have a SECRET_KEY set in your environment by exporting one. Alternatively, you can create an environment file that will be read by the project everytime it starts up by running:

   $ echo "SECRET_KEY=yoursecretkeyhere" >> .env
   

Replace "yoursecretkeyhere" with any random string.

4. Run the development server

   $ npm run start:dev
   

The server will run at http://localhost:8000

Testing

You can run tests by ensuring you have the project set up then running:

$ npm test

Made Using

This web application is made using NodeJS, MongoDB, SocketIO and ReactJS with Redux and ImmutableJS.