ToDo

Index

1. Introduction
2. Clone the repository
3. Using Docker
4. Credits

Introduction

Fast and minimalist to-do app!

This project has been developed on a Linux system. To learn more about the system, visit the Dotfiles repository.

Clone the repository

Open a terminal in the directory where you store your repositories and clone it with the following command:

# HTTPS
git clone https://github.com/FJrodafo/ToDo.git
cd ToDo/

# SSH
git clone git@github.com:FJrodafo/ToDo.git
cd ToDo/

Using Docker

You can find a Docker image of this project ready to be pulled on GitHub Packages or Docker Hub official website!

Pull the latest image with the following commands:

# GitHub Packages
docker pull ghcr.io/fjrodafo/to-do:latest

# Docker Hub
docker pull fjrodafo/to-do:latest

Run with Docker Compose (Recommended)

Make sure you have created a Docker volume named to-do with the following command:

docker volume create to-do

Build the container:

docker compose build

[!NOTE]

If you want to build the image locally, uncomment the build section in docker-compose.yaml and run docker compose build. Otherwise, skip directly to the next step.

Run the container:

docker compose up -d

Check the container logs:

docker logs -f to-do

Stop the Container:

docker compose down

Open http://localhost:3000 in your favorite browser to see the result.

[!IMPORTANT]

If you already have applications that use port 3000, you will need to change the host port before creating the Docker container so that it can run correctly on a free port.

Build Docker image manually

If you prefer not to use Docker Compose, you can build and run the image manually.

If you don’t have Node v24.x or higher installed on your machine, you can build a Docker image by running the Dockerfile.

Create a volume by executing the following command:

docker volume create to-do

Open a terminal and run the following command:

docker build -t to-do:latest .

After the build completes, you can run your container with the following command:

docker run -dp 127.0.0.1:3000:3000 --mount type=volume,src=to-do,target=/etc/todo to-do

Check the container logs:

docker ps -a
docker logs -f <container_id>

Stop and remove the Container:

docker stop <container_id>
docker rm <container_id>

Credits

Forked from docker/getting-started with Apache-2.0 license.