DutyGenerator-Backend 😎🇷🇼 (Task-Force-Challenge)

The Github-page Link of the hosted front-end app HERE

API Endpoints included

User

• POST /signUp: Create an account
• POST /login: Log into your account

Duty (task)

• POST /api/v1/duties: Create a new Task
• GET /api/v1/duties/:ID: Fetch a single Task
• GET /api/v1/duties: Fetch all tasks
• PATCH /api/v1/duties:ID: Update a single task
• DELETE /api/v1/duties:ID: Delete a task

To Access Docker image/container:

Pull the image from Dockerhub

• after pulling the image which is pextech/dutygen:latest make sure you run this command to start the container docker run pextech/dutygen:latest

Installation and Environment Setup

Clone the repository from Github.

( You will need Git for this if you are running a Windows PC, Get it HERE )

git clone https://github.com/pextech/Duty-generator_taskforce.git

To Install all dependencies:

npm install

To run the tests:

npm run test

Now to start the app:

npm run start

To start the app in development mode:

( You need nodemon installed for this, run npm i -g nodemon to install it )

npm run dev-start

Tools used

• Server-Side Framework: Node/Express
• Testing framework: Mocha/Chai
• database: sequelize, postgres

More Tools

• Continuous integration: Travis-Ci
• ES6 Transpiler: Babel
• Test coverage: nyc
• Maintainability: Code climate
• Deployment: Heroku and Netlify

Author

Pextech 😎🇷🇼