david/apocapoc-api
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revise README content

Browse Source
This commit is contained in:
David Folch Agulles
2025-11-28 18:56:35 +01:00
parent 6fb4823183
commit d3111ad52c
1 changed files with 12 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -17
View File
@@ -1,6 +1,6 @@
# Apocapoc API - Self-Hosted Habit Tracker # Apocapoc API - Self-Hosted Habit Tracker
**Lightweight REST API for habit tracking built with Go.** Designed for developers who want full control over their data without relying on third-party services. Deploy in minutes with Docker and start building your own productivity tools. REST API for habit tracking built with Go. Self-hosted alternative for developers who want control over their data.
[![Docker](https://img.shields.io/docker/v/ghcr.io/davidfolch/apocapoc-api?label=docker&logo=docker)](https://github.com/davidfolch/apocapoc-api/pkgs/container/apocapoc-api) [![Docker](https://img.shields.io/docker/v/ghcr.io/davidfolch/apocapoc-api?label=docker&logo=docker)](https://github.com/davidfolch/apocapoc-api/pkgs/container/apocapoc-api)
[![Go Version](https://img.shields.io/github/go-mod/go-version/davidfolch/apocapoc-api)](https://golang.org/) [![Go Version](https://img.shields.io/github/go-mod/go-version/davidfolch/apocapoc-api)](https://golang.org/)
@@ -19,14 +19,13 @@
## Features ## Features
- **Multiple habit types**: Boolean (daily check-ins), Counter (track numbers), Value (measurements) - Multiple habit types: Boolean, Counter, Value
- **Flexible scheduling**: Daily, Weekly, Monthly with custom day selection - Flexible scheduling: Daily, Weekly, Monthly
- **Statistics endpoints**: Streaks, completion rates, and progress tracking - Statistics: Streaks, completion rates, progress tracking
- **Complete history**: Full audit trail of all interactions - JWT authentication, rate limiting, optional email verification
- **Easy deployment**: Single Docker container or binary with embedded SQLite - Registration modes: Open or closed
- **Security**: JWT authentication, rate limiting, optional email verification - SQLite database (single file)
- **Registration modes**: Open or closed for controlled access - Swagger UI at `/api/v1/docs`
- **Interactive docs**: Built-in Swagger UI for testing endpoints
## Quick Start ## Quick Start
@@ -134,14 +133,10 @@ API runs on `http://localhost:8080`
## Use Cases ## Use Cases
Perfect for: - Build your own web or mobile frontend
- Create custom CLI tools or scripts
- **Custom mobile/web apps**: Build your own interface without backend complexity - Keep your habit data on your own infrastructure
- **Personal dashboards**: Integrate with Grafana, Nextcloud, or Home Assistant - Experiment with a small REST API in Go
- **Automation workflows**: Connect to n8n, Zapier, or custom scripts
- **Privacy-focused teams**: Keep sensitive productivity data on your infrastructure
- **API learning projects**: Clean architecture with real-world examples
- **Offline-first tools**: SQLite backend works without cloud dependencies
## API Documentation ## API Documentation