Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.54 KB

README.md

File metadata and controls

75 lines (47 loc) · 1.54 KB
Raw

TaskMaster API

CI for taskMaster Project

codecov

Overview

Welcome to TaskMaster API! This project provides the backend API for the TaskMastere application. It is a robust task manager that allows users to create, update, style and delete their tasks

Documentation

Find the API documentation at https://localhost:3000/api-docs

Installation

To get started with the TaskMaster API, follow these simple steps:

  1. Clone the Repository:

    git clone https://github.com/jkarenzi/task-master-be.git

  2. Install Dependencies:

    npm install

  3. Run the Development Server:

    npm run dev

Testing

  • Run tests

    npm run test

  • Run tests with coverage

    npm run test:ci

Docker

  • Run in docker container

    docker-compose -f docker-compose.yml up

  • Stop the container

    docker-compose -f docker-compose.yml down

  • Run tests in docker container

    docker-compose -f docker-compose.test.yml up --build --abort-on-container-exit --exit-code-from test

Usage

Once the development server is running, you can interact with the API using HTTP requests.

Authors