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 if not already installed.
2. Download and install Mongodb if not already installed.
3. Clone the repository here or go to the project github page here 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

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.
2. Clone the repository or fork it.
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -m 'Add some feature'
5. Push to the branch: git push origin your-new-feature
6. Submit a pull request.

Links

• Follow me on twitter.
• CLI version of Document manager with mongodb.
• CLI version of Document manager with PostgreSQL.
• Document-REST-API