Overview API

Personal Project Management API

Project Management API tailored for my freelancing gigs. Inspired by Trello, Asana, Dapulse & Wrike.

REQUIREMENTS

• Node v8.4.x (LTS: Carbon)
• MongoDB v3.4.x

INSTALLATION

npm install

or with Node Version Manager via .nvrmc

nvm use
npm install

API

Auth (using express-auth dep)

• POST /auth/register
• POST /auth/login
• POST /auth/password/change
• POST /auth/password/reset
• POST /auth/password/reset/confirm

Folder

• GET /folders
• POST /folders
• GET /folders/:folder
• PUT /folders/:folder
• DELETE /folders/:folder

Task

• GET /folders/:folder/tasks
• POST /folders/:folder/tasks
• GET /folders/:folder/tasks/:task
• PUT /folders/:folder/tasks/:task
• DELETE /folders/:folder/tasks/:task

Log

• GET /folders/:folder/tasks/:task/log
• POST /folders/:folder/tasks/:task/log
• GET /folders/:folder/tasks/:task/log/:log
• PUT /folders/:folder/tasks/:task/log/:log
• DELETE /folders/:folder/tasks/:task/log/:log

Workflow

• GET /workflows
• POST /workflows
• GET /workflows/:workflow
• PUT /workflows/:workflow
• DELETE /workflows/:workflow

Priority

• GET /priorities
• POST /priorities
• GET /priorities/:priority
• PUT /priorities/:priority
• DELETE /priorities/:priority

Company / Client

• GET /companies
• POST /companies
• GET /companies/:company
• PUT /companies/:company
• DELETE /companies/:company

Contact

• GET /companies/:company/contacts
• POST /companies/:company/contacts
• GET /companies/:company/contacts/:contact
• PUT /companies/:company/contacts/:contact
• DELETE /companies/:company/contacts/:contact

Self (misc)

• GET /self
• PUT /self

Admin (misc)

• GET /admin/users
• POST /admin/users
• GET /admin/users/:user
• PUT /admin/users/:user
• DELETE /admin/users/:user
• POST /admin/users/:user/reset

TESTS

npm run test

Code coverage:

npm run coverage

CONTRIBUTING

NOTE

Express Auth (Auth Dependency) is still in private development stage. Contributions are recommended after its release.