https://github.com/eroydev/rocket-taskify
Project assignment that a company gave to me to show my skills in backend development using Rust
https://github.com/eroydev/rocket-taskify
Last synced: about 2 months ago
JSON representation
Project assignment that a company gave to me to show my skills in backend development using Rust
- Host: GitHub
- URL: https://github.com/eroydev/rocket-taskify
- Owner: ERoydev
- Created: 2025-02-04T09:31:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-23T19:01:45.000Z (over 1 year ago)
- Last Synced: 2025-03-31T16:26:31.369Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 277 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Management API Documentation
This API manages tasks with basic CRUD operations.
## Table of Contents
- [Tech Stack](#tech-stack)
- [Rocket Taskify Installation Guide](#rocket-taskify-installation-guide)
- [Install Rust](#1-install-rust)
- [Install PostgreSQL](#2-install-postgresql)
- [Create the Database](#3-create-the-database)
- [Configure Database Connection](#4-configure-database-connection)
- [Apply Migrations](#5-apply-migrations)
- [Run the Project](#6-run-the-project)
- [Endpoints](#endpoints)
- [GET /tasks](#get-tasks)
- [POST /tasks](#post-tasks)
- [DELETE /tasks/id](#delete-tasksid)
- [PUT /tasks](#put-tasks)
- [GET /tasks?filter=isCompleted&value=true](#get-tasksfilteriscompletedvaluetrue)
- [Task Priority Levels](#task-priority-levels)
- [Authentication](#authentication-system)
- [Frontend Implementation](#frontend-implementation)
- [Future Improvements](#future-improvements)
$~~~~~~~~~~~$
$~~~~~~~~~~~$
# Tech Stack
## 🚀 Rust
- Systems programming language for performance and safety.
- Guarantees memory safety and concurrency without data races.
## âš¡ Rocket Framework
- Web framework for Rust, ideal for building fast, secure web applications.
- Supports asynchronous programming with `async/await`.
- Type-safe routing and easy request handling (JSON, forms, etc.).
## 🌊 SeaORM
- Asynchronous ORM for Rust, built for SQL databases.
- Supports PostgreSQL, MySQL, and SQLite.
- Provides type-safe, efficient database interactions with migrations.
$~~~~~~~~~~~$
$~~~~~~~~~~~$
# Rocket Taskify Installation Guide
This guide will help you set up and run the Rocket Taskify project using the Rocket framework.
## Prerequisites
Before setting up the project, ensure you have the following installed:
### 1. Install Rust
Rust is required to run this project. Install Rust using `rustup`:
```sh
Make sure you are using rustc 1.84.1 version
```
After installation, restart your terminal and verify the installation:
```sh
rustc --version
```
### 2. Install PostgreSQL
This project requires PostgreSQL as the database. Install it based on your operating system:
- **Ubuntu/Debian:**
```sh
sudo apt update
sudo apt install postgresql postgresql-contrib
```
- **MacOS (Homebrew):**
```sh
brew install postgresql
```
- **Windows (Chocolatey):**
```sh
choco install postgresql
```
### 3. Create the Database
Start the PostgreSQL service and create a database named `rocket_taskify`:
```sh
psql -U postgres
CREATE DATABASE rocket_taskify;
\q
```
Alternatively, use a single command:
```sh
createdb -U postgres rocket_taskify
```
### 4. Configure Database Connection
Navigate to the backend directory of the project:
```sh
cd ./backend/src
```
Edit `setup.rs` to include the correct database URL:
```rust
const DATABASE_URL: &str = "postgresql://:@localhost:5432/rocket_taskify";
```
Replace `` and `` with your actual PostgreSQL credentials.
### 5. Apply Migrations
To apply the database migrations, follow these steps:
1. **Navigate to the backend folder**:
```bash
cd ./backend
2. Run the migration command: Replace and with your PostgreSQL credentials:
```sh
sea-orm-cli migrate up -u postgresql://:@localhost:5432/rocket_taskify
```
Example:
```sh
sea-orm-cli migrate up -u postgresql://admin:mysecurepassword@localhost:5432/rocket_taskify
```
### 6. Run the Project
Finally, start the Rocket server by running:
```sh
cargo run
```
Your Rocket project should now be up and running!
$~~~~~~~~~~~$
$~~~~~~~~~~~$
# Endpoints
### GET /tasks
Fetch all tasks, optionally sorted by priority.
**Query Parameters:**
- `sort`: Filter tasks by priority (`high`, `medium`, `low`, `expired`, `immediate`).
- `/tasks?sort=high` => returns all tasks sorted by high priority
**Response:**
- `200 OK`: Array of tasks.
$~~~~~~~~~~~$
### POST /tasks
Create a new task.
**Request Body:**
```json
{
"title": "Some title",
"description": "Some description",
"due_date": 1738971697, // Unix Timestamp
"is_completed": false,
"is_critical": false
}
```
- *To create a task my application use this data object*
```ru
pub struct NewTask {
pub title: String,
pub description: String,
pub due_date: i64, // i use UNIX-Timestamp
pub is_completed: bool,
pub is_critical: bool,
}
```
$~~~~~~~~~~~$
### DELETE /tasks/id
Delete a task
$~~~~~~~~~~~$
### PUT /tasks
Update a task with new fields
**Request Body:**
```json
{
"id": 12,
"title": "Sometitle",
"description": "Some description",
"priority": "expired",
"due_date": "07-02-25",
"is_completed": false,
"is_critical": false,
"due_date_timestamp": 1738971697
}
```
- *To update a task the application is using this data object
```ru
pub struct TaskDTO {
pub id: i32,
pub title: String,
pub description: String,
pub priority: String,
pub due_date: String, // i use UNIX-Timestamp
pub is_completed: bool,
pub is_critical: bool, // If user update
pub due_date_timestamp: i64,
}
```
$~~~~~~~~~~~$
### GET /tasks?filter=isCompleted&value=true
*Get tasks by completion status provide value either true or false.*
$~~~~~~~~~~~$
### Task Priority Levels
```rs
enum TaskPriorityLevel {
Low,
Medium,
High,
Immediate,
Expired,
}
```
$~~~~~~~~~~~$
$~~~~~~~~~~~$
$~~~~~~~~~~~$
---
HTTP Method
Endpoint
Description
GET
/tasks
Retrieves all tasks sorted by priority (DESC) and due date (ASC) by default.
GET
/tasks?sort=priority
Retrieves all tasks sorted by priority (DESC) and due date (ASC). If a sort query parameter is provided, it filters tasks by the specified priority level (e.g. "high").
GET
/tasks?filter=isCompleted&value=true/false
Retrieves tasks filtered by their completion status. Use filter=isCompleted with value=true or value=false.
GET
/tasks/<id>
Retrieves the task with the specified ID.
POST
/tasks
Creates a new task. Expects task details in JSON (title, description, due_date, is_completed, is_critical).
PUT
/tasks
Updates an existing task. Expects updated task data in JSON.
DELETE
/tasks/<id>
Deletes the task with the specified ID.
POST
/tasks/complete/<id>
Marks the task with the specified ID as complete (and resets the critical flag) and updates its priority accordingly.
POST
/tasks/critical/<id>
Marks the task with the specified ID as critical and updates its priority accordingly.
POST
/tasks/update_priority
Triggers an update of task priorities for all tasks based on the defined business logic.
$~~~~~~~~~~~$
# Authentication System
*Currently i have implemented simple starting point consisting of following relations:*
- Users & Roles: Many-to-Many via UserRoles
- Users & Permissions: Many-to-Many via UserPermissions
- Roles & Permissions: Many-to-Many via RolePermissions
- Users & Profile: One-to-One (Profile)
# Frontend Implementation
*I have implemented frontend just for me to experiment.*
- It's not fully working thats why i don't provide instructions for it, anyway my task was for backend.
# Future Improvements
I want to implement frontend to consume the backend with authentication:
- i will try using solana smart contracts using anchor for education purposes.
- i will upload simple version with front and backend version to use it as a showcase project. I will implement CD/CI git action to build, test, deploy to render.