# offline-todo-api

**Repository Path**: mirrors_leecade/offline-todo-api

## Basic Information

- **Project Name**: offline-todo-api
- **Description**: A painfully simple API to creating/deleting items on a todo list.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# offline-todo-api [![Build Status](https://travis-ci.org/matthew-andrews/offline-todo-api.svg?branch=master)](https://travis-ci.org/matthew-andrews/offline-todo-api)

Simple (hopefully) RESTful API that allows you to create, read, ~~update~~ and delete items from your todo list.

Note: PUT is not supported as todos are intentionally not updateable in this version.

## Install and run

Quick start:

```
npm install -g offline-todo-api
offline-todo-api
```

Full development build:

```
git clone git@github.com:matthew-andrews/offline-todo-api.git
cd offline-todo-api
npm install
node index.js
```

## Documentation

### GET /todos - list all todos

```
curl https://offline-todo-api.herokuapp.com/todos
```

### GET /todos/:id - read a specific todo

```
curl https://offline-todo-api.herokuapp.com/todos/1408228141678
```

### POST /todos - create a new todo

```
curl https://offline-todo-api.herokuapp.com/todos -X POST -d '{"text":"Do the dishes"}' -H "Content-Type: application/json"
```

#### Input

Name    | Type      | Description
------- | --------- | ------------------------------------
text    | string    | **Required**. The todo text
id      | mixed     | **Required**. Some unique identifier

### DELETE /todos/:id - delete a todo

```
curl https://offline-todo-api.herokuapp.com/todos/1408228141678 -X DELETE
```

Note: once an item has been deleted a todo its `id` cannot be reused.

### GET /todos/stream

Can be used as a event source that will stream an `updated` message whenever a todo is created or deleted.