/beyondborders

Primary LanguageTypeScriptMIT LicenseMIT

Beyond Beyonder

xxxx

Features

Getting Started

Follow the steps below to set up and run Task Tracker on your local machine.

Prerequisites

Before you begin, ensure you have the following dependencies installed on your system:

  • Node | JavaScript runtime environment.
  • Npm | Node Package Manager.
  • NestJS | To generate and manage your NestJS application.

Installation

Clone the repository to your local machine

  1. Clone the repository to your local machine:
git clone https://github.com/CyrilBaah/beyondborders.git
  1. Install the project dependencies:
npm install

Running the Application

Start the Task Tracker application using the following command:

npm run start

The application will run on http://localhost:3000.

Lint the Application

npm run lint

Format the Application

npm run format

Usage

1.To create a new task, send a POST request to http://localhost:3000/tasks with a JSON body containing the task title.

Example using cURL:

curl -X POST -H "Content-Type: application/json" -d '{"title": "Task 1"}' http://localhost:3000/tasks

## Using Docker
Refer to the Makefile to already prepare commands | [Makefile](https://github.com/CyrilBaah/beyondborders.git)