Skip to content

Gloomcaller/TeaKeeper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TeaKeeper

A simple personal tea tracker — import a CSV, browse your collection, explore stats, and visualize your tea-drinking habit on a calendar.

Overview

TeaKeeper is a lightweight web application designed for tea enthusiasts who want to track their tea consumption over time. Whether you're exploring flavor preferences or just building a tea diary, this app provides an intuitive interface to log and analyze your tea-drinking habits.

Features

  • Import & Export – Upload tea data via CSV or export your collection for backup
  • Full CRUD operations – Add, edit, browse, and delete individual tea entries
  • Calendar view – Monthly calendar with color-coded tea days and per-date detail view
  • Statistics dashboard – View top brands, monthly distribution, and flavor breakdown
  • Multi-year support – Track your tea habits across multiple years
  • Responsive design – Works seamlessly on desktop, tablet, and mobile devices

Screenshots

Home Page
Home page

Teas Table
Teas table

Calendar View
Tea calendar

Statistics Dashboard
Statistics

Import / Export
Import and Export

CSV Format

The app accepts CSV files with the following format:

drink_date,brand,tea_name,flavor
2025-01-15,Fructus,Earl Grey,Bergamot
2025-01-16,dmBio,Peppermint,Mint
  • The header row is optional
  • flavor is optional per row

Installation & Setup

1. Create Database

Create a MySQL database named tea_keeper using phpMyAdmin or CLI.

2. Import Schema

Import the SQL schema located in data/backups/tea_keeper.sql.

3. Configure Database Connection

Edit includes/database.php with your database credentials.

4. Serve the Project

Run the project locally using any PHP 8+ web server:

php -S localhost:8000

Or use XAMPP, WAMP, or Apache.

5. Load Sample Data

Open the site and import data/default.csv to load sample tea entries.

Usage

  1. Open the application in your browser
  2. Use the Import feature to upload your tea data
  3. Browse all entries in the Teas table
  4. View your tea-drinking patterns in the Calendar view
  5. Explore insights and trends in the Statistics dashboard
  6. Export your data anytime for backup or external use

License

This project is licensed under the MIT License.
See the LICENSE file for more details.

About

Simple CSV Tea Tracker.

Topics

Resources

License

Stars

Watchers

Forks

Contributors