kingisaac95 / docmanager

A beautiful document management system specially made for You!

DocManager

Docmanager is a fullstack application (API endpoints and user interface) that allows users to create and manage documents. It also comes with API endpoints for creating and managing users.

View the app live here

API Summary

Note

All requests must be prefixed with api/v1 For full API documentation, visit our docs

Users

EndPoint	Functionality
POST /users/login	Logs in a user.
POST /users/logout	Logs out a user.
POST /users/	Creates a new user.
GET /users/	Find matching instances of user.
GET /users/?limit={integer}&offset={integer}	Pagination for users.
GET /users/	Find user.
PUT /users/	Update user attributes.
DELETE /users/	Delete user.
GET /search/users/?q={}	Search for a user.

Documents

EndPoint	Functionality
POST /documents/	Creates a new document instance.
GET /documents/	Find matching instances of document.
GET /documents/?limit={integer}&offset={integer}	Pagination for docs.
GET /documents/	Find document.
PUT /documents/	Update document attributes.
DELETE /documents/	Delete document.
GET /users//documents	Find all documents belonging to the user.
GET /search/documents/?q={doctitle}	Search for a doc.

Roles

EndPoint	Functionality
POST /roles/	Creates a new role instance.
GET /roles/	Find matching instances of role.
PUT /roles/:id	Update role attributes.
DELETE /roles/:id	Delete role.

Getting Started

Via Cloning The Repository:

# Get the app locally
git clone https://github.com/kingisaac95/docmanager.git

# Change directory
cd docmanager

# Create .env file in the root directory
touch .env

# Copy .env.example to .env
cp .env.example .env

# Change the secrete key to a key of your choice
SECRETE_KEY=YOUR_SECRETE_HERE

# Create a database (with postgresql)
# And update configuration file at src/server/config/config.json with database credentials

# Install Package dependencies
npm install

# Run your migrations
npm run migrate

# Run your migrations
npm run seed-db

# Run the application
npm start

# Run test migrations
npm run migrate:test

# Run test
npm run test

# Run end to end test
npm run e2e

Issues?

Submit your issue here

How can I thank you?

Why not star the github repo? The attention would be appreciated! How about sharing the link for this repository on Twitter?

Don't forget to follow me on twitter!

Thanks! Orjiewuru Kingdom.

License

The MIT License (MIT). Please see License File for more information.