todo

todo is a self-hosted todo web app that lets you keep track of your todos in a easy and minimal way. 📝

Screenshots

Nord Theme

Dracula Theme

See all themes in the "Preset Color Themes" section below

Demo

There is also a public demo instance avilable at: https://todo.mills.io

Deployment

Docker Compose

docker-compose.yml

version: '3'

services:
  todo:
    image: prologic/todo
    container_name: todo
    restart: always
    ports:
      - 8000:8000
    volumes:
      - todo_db:/usr/local/go/src/todo/todo.db

volumes:
  todo_db:

This file:

• Creates the todo container using the latest image from prologic/todo in Docker Hub.
• Binds port 8000 on your host machine to port 8000 in the container (you may change the host port to whatever you wish).
• Volume mounts the database path, saving your todo items so that your todo list will be saved in between container restarts.

Bring the container up with:

$ docker-compose up

Docker

Alternatively, you can run the container without docker-compose:

$ docker run -p 8000:8000 -v todo_db:/usr/local/go/src/todo/todo.db prologic/todo

Configuration

Preset Color Themes

todo comes with 12 different color themes based on some of the most popular programming themes:

ayu, dracula, gruvbox-dark, gruvbox-light, lucario, monokai, nord, solarized-dark, solarized-light, tomorrow, tomorrow-night, zenburn

You can set the theme by passing the COLOR_THEME environment variable to the docker container, for example:

docker-compose.yml

version: '3'

services:
  todo:
    image: prologic/todo
    container_name: todo
    environment:
      COLOR_THEME: ayu
    restart: always
    ports:
      - 8000:8000
    volumes:
      - todo_db:/usr/local/go/src/todo/todo.db

volumes:
  todo_db:

Custom Color Themes

You can set your own color theme by passing in the appropriate environment variables.

Set the COLOR_THEME environment variable to custom, and the five following environment variables to the colors of your choice (in hex format, omitting the #):

Environment Variable	Description
COLOR_PAGE_BACKGROUND	Web page background
COLOR_INPUT_BACKGROUND	Text boxes and buttons background
COLOR_FOREGROUND	Input and item text
COLOR_CHECK_MARK	Check mark on button
COLOR_X_MARK	X mark on button
COLOR_LABEL	Heading text and button hover

An example configuration:

docker-compose.yml

version: '3'

services:
  todo:
    image: prologic/todo
    container_name: todo
    environment:
      COLOR_THEME: custom
      COLOR_PAGE_BACKGROUND: 282a36
      COLOR_INPUT_BACKGROUND: 44475a
      COLOR_FOREGROUND: f8f8f2
      COLOR_CHECK_MARK: 50fa7b
      COLOR_X_MARK: ff5555
      COLOR_LABEL: ffffff
    restart: always
    ports:
      - 8000:8000
    volumes:
      - todo_db:/usr/local/go/src/todo/todo.db

volumes:
  todo_db:

Additional Configuration

Environment Variable	Description	Default Value
MAX_ITEMS	Maximum number of items allowed in the todo list	100
MAX_TITLE_LENGTH	Maximum length of a todo list item	100

Development / Non-Dockerized Deploy

You can quickly run a todo instance from source using the Makefile:

$ git clone https://github.com/prologic/todo.git
$ cd todo
$ make

Then todo will be running at: http://localhost:8000

By default todo stores todos in todo.db in the local directory.

This can be configured with the -dbpath /path/to/todo.db option.

License

MIT

Icon made by Smashicons from flaticon.com