Task Manager

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

🎯 About

A Task Management backend application that allows authenticated users to Create, Update & Delete Tasks.

✨ Features

✔️ User Authentication with fastify/jwt;
✔️ CRUD Tasks;
✔️ Filter & Sort Tasks;
✔️ Add Labels To Tasks;

🚀 Technologies

The following tools were used in this project:

• Fastify
• Sequelize ORM
• Node.js
• Docker Compose
• MySQL
• TypeScript

✅ Requirements

Before starting 🏁, you need to have Git, Node and Docker installed.

🏁 Starting

.env

#root directory .env values
DB_USER=jellyman
DB_PASSWORD=jellyman
DB_NAME=task_manager

#backend directory .env values
DB_HOST=localhost
DB_PORT=3306
DB_USER=jellyman
DB_PASSWORD=jellyman
DB_NAME=task_manager
JWT_SECRET=verysecretsecret

# Clone this project
$ git clone https://github.com/nkosi-tauro/task-manager

# Access
$ cd task-manager

# Create a .env file for both the root and backend directories
$ See .env section above

# Install dependencies & Run project
$ docker compose up

# Test the project Endpoints
$ See Postman Section below

# The server will initialize on <http://localhost:3000>

Postman

Download the Postman Collection and Import it.
Download Collection Or View the "Munch Backend.postman_collection.json" file in the root directory.

Testing

After setting up the Project:
To Run Tests you can startup just the database or else the ports will conflict.

# (Only do this if you want to run tests)

# Database Startup
$ docker compose up db

# Access
$ cd backend

# install packages 
$ npm i

# run tests
$ npm test

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Nkosilathi Tauro

 

Back to top