diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..02900fc --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +# Release archives +releases/ + +# OS files +.DS_Store +Thumbs.db + +# IDE files +.vscode/ +.idea/ +*.swp +*.swo +*~ diff --git a/RELEASE_NOTES_MPG_v1.0.0.md b/RELEASE_NOTES_MPG_v1.0.0.md new file mode 100644 index 0000000..eaa71fc --- /dev/null +++ b/RELEASE_NOTES_MPG_v1.0.0.md @@ -0,0 +1,62 @@ +# MPG Fuel Log Tracker - Release v1.0.0 + +**Release Date:** October 28, 2025 + +## ๐ŸŽ‰ Initial Release + +This is the first official release of the MPG Fuel Log Tracker, a lightweight PHP-based fuel tracking web application. + +## โœจ Features + +- **Per-vehicle fuel logs** stored in JSON format +- **MPG calculation** based on prior odometer readings +- **Export to CSV** for data analysis +- **Admin dashboard** with plate summaries and raw JSON links +- **Trend chart** showing MPG over time using Chart.js +- **Timezone support** - All timestamps recorded in Eastern Time (ET) +- **Modern UI** with reusable top-right menu +- **Authentication system** with login/logout functionality + +## ๐Ÿ“ฆ What's Included + +- Complete PHP application files +- Documentation (README.md, CHANGELOG.md) +- Example configuration files +- Login/authentication system +- Admin dashboard +- Data export functionality +- Chart visualization + +## ๐Ÿ”ง Requirements + +- PHP 8.2 or higher +- Web server (Apache/Nginx) +- Writable logs directory + +## ๐Ÿ“ฅ Installation + +1. Download and extract the release archive +2. Upload all files to your `/mpg/` directory +3. Ensure `logs/` folder exists and is writable (chmod 755 or 775) +4. Enable PHP 8.2 or higher on your hosting plan +5. Visit `index.php` to begin entering logs + +## ๐Ÿ“– Documentation + +For detailed setup instructions and feature documentation, see the [README.md](https://github.com/jasrasr/website/blob/main/mpg/README.md) file. + +For version history, see [CHANGELOG.md](https://github.com/jasrasr/website/blob/main/mpg/CHANGELOG.md). + +## ๐Ÿ“„ License + +MIT License + +## ๐Ÿ‘ค Author + +Jason Lamb (https://jasonlamb.me) + +--- + +**Download Options:** +- [mpg-v1.0.0.tar.gz](../../releases/mpg-v1.0.0.tar.gz) - Linux/Mac +- [mpg-v1.0.0.zip](../../releases/mpg-v1.0.0.zip) - Windows/All platforms diff --git a/RELEASE_SUMMARY.md b/RELEASE_SUMMARY.md new file mode 100644 index 0000000..6d83707 --- /dev/null +++ b/RELEASE_SUMMARY.md @@ -0,0 +1,86 @@ +# MPG v1.0.0 Release Summary + +## โœ… Completed Tasks + +1. **Version Documentation** + - Created `mpg/VERSION` file containing version number (1.0.0) + - Updated `mpg/README.md` with version header and release date + - Created `mpg/CHANGELOG.md` with initial release notes + +2. **Release Archives** + - Created `releases/mpg-v1.0.0.tar.gz` (7.9K) - for Linux/Mac users + - Created `releases/mpg-v1.0.0.zip` (16K) - for Windows/all platforms + - Archives exclude log files and contain all application code + +3. **Repository Configuration** + - Created root `.gitignore` to exclude release archives from version control + - Created `RELEASE_NOTES_MPG_v1.0.0.md` with comprehensive release information + +4. **Git Tag** + - Created annotated git tag `mpg-v1.0.0` with detailed release message + - Tag is ready to be pushed to remote repository + +## ๐Ÿ“‹ Next Steps (Manual Actions Required) + +The following actions require GitHub API access or manual intervention: + +### 1. Push the Git Tag +Run the following command to push the tag to GitHub: +```bash +git push origin mpg-v1.0.0 +``` + +### 2. Create GitHub Release +Once the tag is pushed, create a GitHub release: +1. Go to https://github.com/jasrasr/website/releases/new +2. Select tag: `mpg-v1.0.0` +3. Release title: "MPG Fuel Log Tracker v1.0.0" +4. Description: Copy content from `RELEASE_NOTES_MPG_v1.0.0.md` +5. Attach files: + - `releases/mpg-v1.0.0.tar.gz` + - `releases/mpg-v1.0.0.zip` +6. Click "Publish release" + +## ๐Ÿ“ฆ Release Package Contents + +The release archives include: +- All PHP application files (index.php, admin.php, etc.) +- Documentation (README.md, CHANGELOG.md, VERSION) +- Configuration files (.gitignore) +- Empty logs directory structure +- Helper files (menu.php, fuel_form.php, etc.) + +**Excluded from archives:** +- JSON log files +- logs.old directory +- Sensitive configuration files (already in .gitignore) + +## ๐Ÿ”— Links + +- Repository: https://github.com/jasrasr/website +- MPG Folder: https://github.com/jasrasr/website/tree/main/mpg +- Release Notes: ./RELEASE_NOTES_MPG_v1.0.0.md +- Changelog: ./mpg/CHANGELOG.md + +## ๐Ÿ“ Release Notes Summary + +**MPG Fuel Log Tracker v1.0.0** - Initial Release + +Features: +- Per-vehicle fuel logs in JSON format +- MPG calculation and tracking +- Export to CSV functionality +- Admin dashboard with statistics +- MPG trend charts using Chart.js +- Login/logout authentication system +- Modern responsive UI with top-right menu +- Eastern Time (ET) timezone support + +Requirements: +- PHP 8.2 or higher +- Web server (Apache/Nginx) +- Writable logs directory + +License: MIT + +Author: Jason Lamb (https://jasonlamb.me) diff --git a/mpg/CHANGELOG.md b/mpg/CHANGELOG.md new file mode 100644 index 0000000..bd98944 --- /dev/null +++ b/mpg/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +All notable changes to the MPG Fuel Log Tracker will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] - 2025-10-28 + +### Added +- Initial release of MPG Fuel Log Tracker +- Per-vehicle fuel logs stored in JSON format +- MPG calculation (if prior odometer exists) +- Export to CSV functionality +- Admin dashboard with plate summaries and raw JSON links +- Trend chart (MPG over time) using Chart.js +- All timestamps recorded in Eastern Time (ET) +- Modern UI with reusable top-right menu +- Login/logout authentication system +- View latest log per vehicle +- View chart for MPG trends over time + +### Features +- `index.php` - Entry form for fuel logging +- `fuel_form.php` - Modular HTML form used by index.php and save_log +- `save_log.php` - Processes form, saves logs, calculates MPG +- `export_csv.php` - Exports logs as CSV per plate +- `view_latest.php` - Shows most recent log for a plate +- `view_chart.php` - Displays MPG chart for plate using Chart.js +- `admin.php` - Admin dashboard listing all plates + stats +- `menu.php` - Top-right nav menu (icons + tooltips) +- `login.php` - Authentication page +- `logout.php` - Session termination + +### Technical Details +- Requires PHP 8.2 or higher +- JSON-based data storage +- MIT License diff --git a/mpg/README.md b/mpg/README.md index 1f9e4c2..7b69736 100644 --- a/mpg/README.md +++ b/mpg/README.md @@ -1,6 +1,9 @@ # MPG Fuel Log Tracker +**Version:** 1.0.0 +**Release Date:** 2025-10-28 + This is a lightweight PHP-based fuel tracking web application. ## Features @@ -28,6 +31,7 @@ This is a lightweight PHP-based fuel tracking web application. | php.ini | Enables full error display + logging | | .htaccess | PHP error override flags | | README.md | This file | +| CHANGELOG.md | Version history and release notes | ## Setup Instructions @@ -40,6 +44,10 @@ This is a lightweight PHP-based fuel tracking web application. MIT License +## Changelog + +See [CHANGELOG.md](CHANGELOG.md) for version history and release notes. + --- Author: Jason Lamb (https://jasonlamb.me) -Generated with ChatGPT ยท Revision 1.0 ยท Last Updated: 2025-10-28 21:12:55 +Generated with ChatGPT ยท Version 1.0.0 ยท Released: 2025-10-28 diff --git a/mpg/VERSION b/mpg/VERSION new file mode 100644 index 0000000..3eefcb9 --- /dev/null +++ b/mpg/VERSION @@ -0,0 +1 @@ +1.0.0