Skip to content

This repo is meant to hold the backend code for the TOC + Blackrock coding project

Notifications You must be signed in to change notification settings

zeke13210/blackrock_backend

Repository files navigation

blackrock_backend

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

  1. postTask/ Description: Add a task based on the parameters: Name, Description, Priority and Max run time

  2. getTasks/ Description: pull all tasks with the status of ACTIVE and order by priority

  3. getTaskById/ Description: Pull a task based off of a given ID value

  4. updateTaskById/ Description: Update a task based on a given task ID value

Getting Started

To download and utilize this API on your local machine please follow the below instructions

  1. clone repo

  2. Open cmd prompt run

sudo pip install docker-compose

  1. Navigate to local instance of repo and run

docker-compose build

  1. Once build is complete run cmd

docker-compose up

  1. Navigate to localhost:5000 then follow the below docs to utilize the API.

Standard TaskManager API

To access the standard API docs for how to use the API please refer to the Standard docs

ERROR Testing API

To access the Error testing API please refer to the hi Error Testing API docs

Admin API

To access the admin API for the thread service docs please refer to the Admin API docs

Contribution Guidelines

If you're interested in contributing and futher developing this project please refer to the contribution guildelines

Authors

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

Current Team

  • Kenyatta Daniels
  • Justin Traille
  • Zachary Farley

About

This repo is meant to hold the backend code for the TOC + Blackrock coding project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •