Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 947 Bytes

README.md

File metadata and controls

47 lines (35 loc) · 947 Bytes
Raw

Todo API Server

Convenient and secure note server. Allows users to easily store todo tasks that are accessible from anywhere.

Installation

This server is designed to run in a cloud environment for easy access from any command line. It can also be run as a docker container using the Dockerfile, just make sure you forward port 9000.

To run the docker container on your local machine, use the following command

docker run -d --name todoapi --mount source=tododb,target=/mnt/data/ -p 9000:9000 jpetersenames/todoapi:latest

Usage

There are a few routes available through the API

Get the system hostname

<host>:9000/api/system

Create a task

<host>:9000/api/create

List a single task

<host>:9000/api/tasks/{id}

List all tasks

<host>:9000/api/tasks

Update a single task

<host>:9000/api/update/{id}

Delete a single task

<host>:9000/api/delete/{id}