monasr6 / Task-Management

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

This application is a task management system built with NestJS. It provides a robust backend API with a wide range of features, making it a comprehensive solution for managing tasks.

Key features include:

• User Management: The application supports user registration and authentication. Users can sign up, log in, and manage their profiles.

• Task Management: Users can create, read, update, and delete tasks. Each task has a status that can be updated as needed.

• Authentication and Authorization: The application uses JWT for authentication. It also includes guards to ensure that only authenticated users can perform certain operations.

• Database: The application uses PostgreSQL for data storage, providing a robust and scalable solution for managing application data.

• Testing: The application includes comprehensive unit and integration tests, ensuring that all features work as expected.

• Swagger: The application includes a Swagger UI for easy testing and exploration of the API.

• Docker: The application is Docker-ready, making it easy to build and deploy in any environment.

• File Management: The application uses Multer for handling file uploads. This includes features like updating user profile photos.

To get started with the application, follow the installation and running instructions below.

Configuration

Create a default.yml file in the config directory with the following content:

db:
  type: postgres
  host: ${DB_HOST} # Use 'localhost' for local development and 'postgres' for Docker
  port: 5432
  username: postgres
  password: postgres
  database: taskmanagement
  synchronize: true
jwt :
  secret : secret
  expiresIn : 3600
server :
  port: 3003

## Installation

```bash
$ yarn install

If you're running the application locally, you can set the DB_HOST environment variable to localhost in your .env file:

DB_HOST=localhost

This section explains how to create the default.yml configuration file and how to set the DB_HOST environment variable for local development and Docker. It also includes examples of the default.yml, .env, and docker-compose.yml files.

Running the app in Docker

To run the application in Docker, you can use the docker-compose.yml file:

docker-compose up --build

This command builds the Docker images and starts the Docker containers as defined in the docker-compose.yml file.

If you're running the application in Docker, you should set the DB_HOST environment variable to postgres in your docker-compose.yml file:

services:
  app:
    environment:
      DB_HOST: postgres

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

License

Nest is MIT licensed.