This repo is meant to hold the backend code for the Technologist of Color + Blackrock coding project. The project guildelines and tasks include building a backend API with 4 endpoints described below
-
postTask/ Description: Add a task based on the parameters: Name, Description, Priority and Max run time
-
getTasks/ Description: pull all tasks with the status of ACTIVE and order by priority
-
getTaskById/ Description: Pull a task based off of a given ID value
-
updateTaskById/ Description: Update a task based on a given task ID value
To download and utilize this API on your local machine please follow the below instructions
-
clone repo
-
Open cmd prompt run
sudo pip install docker-compose
- Navigate to local instance of repo and run
docker-compose build
- Once build is complete run cmd
docker-compose up
- Navigate to localhost:5000 then follow the below docs to utilize the API.
To access the standard API docs for how to use the API please refer to the Standard docs
To access the Error testing API please refer to the hi Error Testing API docs
To access the admin API for the thread service docs please refer to the Admin API docs
If you're interested in contributing and futher developing this project please refer to the contribution guildelines
This backend API was designed and developed by the below list of dedicated developers apart of the Technologist of Color members taking part in the Blackrock Coding challenge
- Kenyatta Daniels
- Justin Traille
- Zachary Farley