Table of Contents

1. About The Project
2. Built With
3. Getting Started
4. Prerequisites
5. Installation
6. Contact

About The Project

This project is a comprehensive Multi-User Task Management API designed to demonstrate backend development skills and proficiency. The API supports user management with role-based access control, allowing both regular users and admins to manage tasks efficiently. The project is built with the following:

Built With

• NestJS
• PassportJS
• TypeORM
• Mailgun
• NestJS-OpenAPI
• Json Web Tokens(JWT)
• WebSockets
• Class Validator
• Relational Database(Postgres)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is a list of things you will need to use the software and how I got to work on this project

• Node 20.16.0
• NestJS 10.1.16
• Postgres

Installation

1. Clone the repo

   https://github.com/edwinedjokpa/multi-user-task-management-api.git

2. create db in local postgres
3. create a .env file in root folder, copy and replace everything in .env.example and fill in with your credentials
4. run migrations with npm run migration:run
5. run application with npm run start:dev
6. use http://localhost:5000/api/ to test endpoint with swagger

Contact

• Edwin Edjokpa

• @linkedin

• [email protected]

• WhatsApp : 08137016881