https://github.com/rowlandekemezie/document-management-system

DocKip is a document management system for managing and sharing documents: Staging => http://dockip-staging.herokuapp.com. Production =>
https://github.com/rowlandekemezie/document-management-system

angular angular-material javascript mean-stack mongodb nodejs pug pugjs

Last synced: 4 months ago
JSON representation

DocKip is a document management system for managing and sharing documents: Staging => http://dockip-staging.herokuapp.com. Production =>

• Host: GitHub
• URL: https://github.com/rowlandekemezie/document-management-system
• Owner: rowlandekemezie
• License: mit
• Created: 2016-01-15T09:20:59.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-17T15:36:17.000Z (over 7 years ago)
• Last Synced: 2024-10-10T23:03:38.174Z (4 months ago)
• Topics: angular, angular-material, javascript, mean-stack, mongodb, nodejs, pug, pugjs
• Language: JavaScript
• Homepage: http://dockip.herokuapp.com
• Size: 4.6 MB
• Stars: 31
• Watchers: 7
• Forks: 22
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Travis Ci](https://img.shields.io/travis/mentrie/Document-Management-System.svg)](https://travis-ci.org/mentrie/Document-Management-System)

[![Coveralls](https://img.shields.io/coveralls/mentrie/Document-Management-System.svg)](https://coveralls.io/github/mentrie/Document-Management-System)

# DocKip

DocKip is a role-based document management system built with Express, Node, and MongoDB. The application allows you to manage users, roles and documents with assigned authorization. Basically, it helps you to create, share and manage documents with ease. 

## Installation

1. Download and install [**Node JS**](https://nodejs.org/en/) if not already installed.

2. Download and install [**Mongodb**](https://www.mongodb.org/downloads/) if not already installed.

3. Clone the [**repository here**](hhttps://github.com/andela-rekemezie/Document-Management-System.git) or go to the project github page [**here**](https://github.com/andela-rekemezie/Document-Management-System) and download the zip file of the project. Unzip it.

4. Navigate to your terminal and change your directory to the **Document-Management-System**.

5. Run `npm install` to install node dependencies.

6. Run `bower install` to install frontend dependencies.

7. Place a `.env` file on the project's root directory and add your database configuration.

 **EXAMPLE**

   `DATABASE_URL=mongodb://localhost:27017/testdb.`

8. Run `npm run initDb` to initialize your database with a SuperAdmin user.

### Project Management

Pivotal Tracker was used as the management too; throughout the process of building this application.

Checkout [Pivotal Tracker Board](https://www.pivotaltracker.com/n/projects/1515820)

### Usage

The application allows for the SuperAdmin to manage the entire process and assign authorization for different roles.

 1. Run `npm install gulp -g`.

 2. Run `gulp` on your terminal.

 3. Navigate to `http://localhost:5555` on your browser.

### Test

Run `gulp test` on your terminal. Remember to  run test on the project root directory.

### Contributing

1. Create an issue. First look through [the open issues](https://github.com/andela-rekemezie/Document-Management-System/issues).

2. Clone the repository or fork it.

3. Create your feature branch: `git checkout -b my-new-feature`

5. Commit your changes: `git commit -m 'Add some feature'`

4. Push to the branch: `git push origin your-new-feature`

5. Submit a pull request.

###  Links

* Follow me on [twitter](https://twitter.com/EkemezieRowland).

* [CLI version of Document manager with mongodb](https://github.com/andela-rekemezie/DMS-Mongoose).

* [CLI version of Document manager with PostgreSQL](https://github.com/andela-rekemezie/DMS-Sequelize).

* [Document-REST-API](https://github.com/andela-rekemezie/Document-Manager-REST-API)