CooperandGoodman/bourbonacci
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README: name origin, about page, login redirect, new page

Browse Source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Derek Cooper
2026-03-24 22:22:50 -07:00
parent 46499f4cb9
commit a9de081a8a
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -4,6 +4,10 @@ A self-hosted infinity bottle tracker. Log every bourbon you add to your blend,
Built with FastAPI, vanilla JS, and MySQL — fully containerized with Docker Compose. No framework dependencies on the frontend. Built with FastAPI, vanilla JS, and MySQL — fully containerized with Docker Compose. No framework dependencies on the frontend.
## The Name
**Bourbonacci** is a blend of *Bourbon* and the *Fibonacci sequence*. The Fibonacci sequence — 1, 1, 2, 3, 5, 8, 13… — builds endlessly on everything that came before it, with no defined end. An infinity bottle works the same way: every addition layers on top of the existing blend, compounding in complexity over time. Just like the sequence, your bottle is never truly finished.
## Features ## Features
- **Infinity bottle tracking** — log `add` entries (bourbon name, proof, shots) and `remove` entries (shots consumed) - **Infinity bottle tracking** — log `add` entries (bourbon name, proof, shots) and `remove` entries (shots consumed)
@@ -13,6 +17,7 @@ Built with FastAPI, vanilla JS, and MySQL — fully containerized with Docker Co
- **Settings modal** — update display name, bottle size, timezone, and password from any page via the gear icon - **Settings modal** — update display name, bottle size, timezone, and password from any page via the gear icon
- **Admin panel** — list all users, reset passwords, disable/enable accounts, delete users, and impersonate any user for debugging - **Admin panel** — list all users, reset passwords, disable/enable accounts, delete users, and impersonate any user for debugging
- **JWT auth** — Bearer token auth with impersonation support (admin tokens carry an `admin_id` claim) - **JWT auth** — Bearer token auth with impersonation support (admin tokens carry an `admin_id` claim)
- **About page** — public explainer on what an infinity bottle is, why to track it, and how to get started
## Stack ## Stack
@@ -53,6 +58,7 @@ bourbonacci/
│ └── requirements.txt │ └── requirements.txt
├── frontend/ ├── frontend/
│ ├── index.html # Landing page + public community bottles │ ├── index.html # Landing page + public community bottles
│ ├── about.html # What is an infinity bottle? + Bourbonacci explainer
│ ├── login.html │ ├── login.html
│ ├── register.html │ ├── register.html
│ ├── dashboard.html # My Bottle — stats, fill bar, entry log │ ├── dashboard.html # My Bottle — stats, fill bar, entry log
@@ -75,7 +81,8 @@ bourbonacci/
| Page | Auth | Description | | Page | Auth | Description |
|---|---|---| |---|---|---|
| `/index.html` | No | Landing page with community bottle cards; click to browse bourbons | | `/index.html` | No | Landing page with community bottle cards; click to browse bourbons |
| `/login.html` | No | Login form | | `/about.html` | No | What is an infinity bottle? Why Bourbonacci? How to get started |
| `/login.html` | No | Login form — redirects to `/index.html` on success |
| `/register.html` | No | Registration form | | `/register.html` | No | Registration form |
| `/dashboard.html` | Yes | My Bottle — stats, fill bar, full entry log with delete | | `/dashboard.html` | Yes | My Bottle — stats, fill bar, full entry log with delete |
| `/log.html` | Yes | Log an add or remove entry | | `/log.html` | Yes | Log an add or remove entry |