michaelradu / ActixWebTaskService

A simple task management web service built with Actix Web and AWS DynamoDB.

ActixWeb Task Service

This is a simple task management web service built with Actix Web and AWS DynamoDB.

Check out the documentation below to get started.

Feature request? Check the past discussions to see if it has been brought up previously. Otherwise, feel free to start a new discussion thread. All ideas are welcomed!

Quick Start Guide

1. Clone the repo

git clone https://github.com/michaelradu/ActixWebTaskService.git

2. Add your aws_config to your environment variables
3. Build the project

cargo build

4. Run the project

sudo cargo run

5. Test its functionality with tools such as postman

Usage

1. Create tasks

POST http://127.0.0.1/task

with the following body

{
    "user_id": "randomuuid",
    "task_type": "Your_task_type",
    "source_file": "your_file"
}

2. Get tasks

GET http://127.0.0.1/task/taskid 

3. Start a task

PUT http://127.0.0.1/task/taskid/start

4. Pause a task

PUT http://127.0.0.1/task/taskid/pause

5. Complete a task

PUT http://127.0.0.1/task/taskid/complete

with the following body

{
    "result_file": "your_file"
}

6. Fail a task

PUT http://127.0.0.1/task/taskid/fail

and more...

Licence

GPLv3 © Michael Radu