Oh My TASK API

Lightweight task management API (TO-DO), designed as a flexible foundation for building more complex TODO applications.

Languages

• 🇪🇸 Español
• 🇧🇷 Português

Table of Contents

• Dependencies
• Main Features
• Technologies Used
• Installation
• Documentation
• License
• Contributing
• Contact

Dependencies

This project relies on two fully auditable Rust-based dependencies:

• R-BACKUPS – Database manager
• R-PERMS – Simple and fast permissions calculator

Main Features

• User management with defined statuses (Active, Inactive, Blocked, Deleted) and roles with associated permissions.
• Full CRUD for tasks, subtasks, categories, tags, milestones, and comments.
• Status and priority control for tasks and subtasks.
• Many-to-many relationships between tasks/subtasks and tags, comments, and attachments.
• Support for attachments with metadata, linked to tasks and subtasks.
• Scheduled notification system associated with tasks.
• Detailed history log for auditing with JSON data.
• User-specific limits configuration including max tasks, tasks per milestone, tags, categories, subtasks per task, comments, milestones, and attachment storage.

Technologies Used

• Backend: NestJS, TypeORM, TypeScript
• Database: PostgreSQL
• Cache: Redis
• Authentication: JWT, bcrypt for password hashing
• File Storage: gRPC communication with a Rust-based file storage service (r-filestorage)
• Permissions: Bitmask-based system using r-perms to calculate permissions
• Validation: class-validator, class-transformer
• Real-time: WebSockets via socket.io (for comments and notifications)
• Infrastructure: Docker & Docker Compose
• Support Services: Rust binaries (r-backups for DB management, r-perms for permissions)

Installation

1. Requirements

• Docker installed
• PostgreSQL database
• Redis service
• r-filestorage service (Repository) (Optional if you modify src/modules/attchments accordingly)

2. Copy and configure .env and r-backups.json files

cp .env.template .env
cp .docker/.env.template .env
cp r-backups.json.template r-backups.json

Configure all environment variables correctly.

3. Run the Docker image

cd .docker/
docker compose up -d

4. Create the database

• Manually create the database using the files in src/database/ in the following order:
  • types.sql: Contains custom types required.
  • init.sql: Contains all tables used by the API.
  • functions.sql: Functions required by the database.
  • triggers.sql: Contains automatic update triggers for created_at and updated_at fields.
  • indexs.sql: Contains necessary indexes for performance.
• Alternatively, use the provided binary to set up the database automatically:
  • Ensure r-backups.json is configured based on r-backups.json.template.
  • Enter the active container:

docker exec -it app-tasks-api bash

• Run:

npm run db:create

5. Run the project in development mode

docker exec -it app-tasks-api bash

Then run:

npm ci
npm run dev

6. Change the default user password

Generate a password hash:

npm run gen:pass YourStrongPassword@123

Update the user in the database:

update users
set password = '<hash>' -- Replace <hash> with the generated hash
where id = 1;

7. Verify the API

Visit localhost at the port configured in .docker/.env (APP_PORT), e.g., https://localhost:3000. You will receive a JSON response with API status, name, and version.

8. Obtain a user TOKEN (If AUTH_METHOD=bearer in .env)

Send a POST request to http://localhost/auth/login with the following JSON body:

{
    "email": "admin@admin.com",
    "password": "YourStrongPassword@123"
}

The response will return the token:

{
    "token": "JWT_TOKEN"
}

Use this token in the Authorization header for all API requests.

Documentation

Once the project is running in development mode, the documentation is available at /docs following the OpenAPI (Swagger) standard.

License

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

Contributing

Contributions are welcome! You can open issues to report bugs or suggest improvements, and submit pull requests for new features, documentation updates, or fixes. Please follow best practices and maintain code consistency.

Contact

For questions, suggestions, or any inquiries about this project, contact me at: hormigadev7@gmail.com