To do - Advanced

Redefining Task Management with Advanced Features

"To Do - Advanced" is a task list application with advanced features, including user authentication and an audit log to track all user actions.

Table of Contents

• Table of Contents
• Getting Started
  • Prerequisites
  • Installation
  • Environment Variables
  • Running Locally
• License

Getting Started

To get started with this project, follow these steps:

Prerequisites

Ensure you have the following installed on your local development environment:

• Docker
• Node.js
• npm (Node Package Manager, comes with Node.js)

Installation

Clone the project and access the folder

git clone https://github.com/PaulosSouza/to-do-advanced.git && cd to-do-the-new-way

Install the dependencies

npm install

Docker volume for mongodb It is necessary to set the permissions of the mongodb folder to 777 before starting the container.

mkdir -p .docker/mongodb && sudo chmod -R 777 .docker/mongodb

Run docker compose

docker-compose up -d

Environment Variables

Creates a .env file in the root of your project that must be a copy from .env.example.

cp .env.example .env

Running Locally

To run the project locally, use the following command:

If you did not run the Docker Compose command and already have MongoDB and PostgreSQL set up with your credentials, you must update the MONGODB_URL and POSTGRESQL_URL environment variables accordingly.

npm run start:dev

License

This project is licensed under the MIT License - see the LICENSE file for details.