diff --git a/README.md b/README.md index 8aec3a3c..0c53a3fc 100644 --- a/README.md +++ b/README.md @@ -34,4 +34,57 @@ To run for production: bun start ``` -This project was created using `bun init` in bun v1.2.19. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime. +This project was created using `bun init` in bun v1.2.19. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.' + +# GarageApp / hammond port + +This is a WIP porting of hammond, and will probably be put in it's own repo when ready. + +todo in random order: +- [x] Create Your Vehicles module +- [ ] Finish main app site +- [ ] Make sure DB is created properly +- [ ] Change DB to contain img for vehicles +- [ ] Create Admin dashboard +- [ ] Finish user hanling (login, what is viewed by who) +- [ ] Set up translations for all parts properly +- [ ] Create Vehicle view +- [ ] Create new vehicle form +- [ ] Check imports + - [ ] Check that imports from Hammond works + - [ ] Check that imports from Clarkson works + - [ ] Check that imports from Fuelly works + - [ ] Check that imports from Drivvo works + - [ ] Check that imports from Generic CSV works +- [ ] Create Quick Entry module +- [ ] Create Add Fillup +- [ ] Create Add Expense +- [ ] Fix DockerFile + +todo new features (features not in hammond): +- [ ] darkmode/lightmode switch +- [ ] Ability to set favicon and Icon as Admin +- [ ] Add Vehicle type hybrid and PHEV needs to be allowed to both charge and add petrol/diesel + -[ ] Add ability for vehicles to have more than one tank +- [ ] Archive Vehicle + - [ ] Export data for single vehicle +- [ ] Connect attachements to expense reports +- [ ] documentation (generally all features should be documented in how they work/what input is expected) +- [ ] external login support (OIDC/SAML and social logins) +- [ ] Vehicle notes +- [ ] fillup/expense notes +- [ ] Allow fillups/expense to add timestamp (Not just date) +- [ ] Add PGSQL, mariaDB and mysql support +- [ ] fillups/expense add timezone +- [ ] recurring costs (Car loan etc.) +- [ ] Add additional info to vehicles + - [ ] Wheel size + - [ ] Oil Type + - [ ] Whiper size +- [ ] Allow for external image storage +- [ ] Add car images + - [x] add placeholder image + - [ ] add ability in DB +- [ ] Add PDF printout of vehicle expense history, with attachements +- [ ] Add Ability to change language per user (keep stored in user settings) +