Skip to content
dermutePublic

About

A simple, self-hosted period tracker with a calendar and cycle forecasts.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Cycle

Cycle demo: log period dates, undo a tap, and see the next estimated forecast

A small, self-hosted, private period calendar. Data is stored in a SQLite database on the server at ./data/cycle.db, so every client using the same deployment sees the same calendar.

Run locally

Install Git and Docker with the Docker Compose plugin, then clone the repository and start the published image:

git clone https://github.com/dermute/cycle.git
cd cycle
docker compose pull
docker compose up -d

Open http://localhost:8080. The Compose file runs ghcr.io/dermute/cycle:latest; it does not build the local source. Calendar data is stored at ./data/cycle.db in the cloned repository and mounted at /data/cycle.db inside the container.

To update, run docker compose pull followed by docker compose up -d from the same directory. To stop, run docker compose down; the data/ directory is preserved.

Back up the data/ directory while the container is stopped to preserve the calendar. There is deliberately no authentication, and the default port mapping exposes port 8080 on all host interfaces, so use a trusted private network or your own access control. For multiple devices, access the same deployment via its private-network address or a reverse proxy.

AI attribution

This project was developed with AI assistance.

License

MIT - see LICENSE.

About

A simple, self-hosted period tracker with a calendar and cycle forecasts.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

Contributors

Languages