fast-calorie/README.md

50 lines
2.1 KiB
Markdown
Raw Normal View History

2020-09-20 01:27:53 +00:00
# Fast Calorie
> Single-Page Progressive Web App
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
There are lots of calorie counting apps out there, and a lot of good ideas, however I thought I could build an app to make entering your calories *even* FASTER.
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
In most apps, your search for food or drinks by name, or you *try* to scan the barcode, but your often left without finding the exact item you wanted or *none at all*. **That sucks!** In **Fast Calorie** searching is based on the calorie count -- AND not just "A" calorie count but calories for the food and drinks you consume -- not 80% of the things you would never touch!
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
This is YOUR app, your CALORIES, and your DATA!
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
## Development
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
Beyond the usefulness of the app, every creation is a chance to explore new technologies, and boldly go where you otherwise fear to tread, because... you know... you would have to support it if it didnt scale!
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
Building small things with tiny libraries is my joy, and this app is no different. The corner stone of this development built around [Litedom](https://litedom.js.org/), a very small view library
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
### Stack
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
- [Litedom JS](https://litedom.js.org/) - A Tiny View Library
- [Matrialize CSS](https://materializecss.com/) - A Not so Tiny CSS Framework
2020-09-20 02:12:48 +00:00
- [DexieDB](https://dexie.org/) - A Robust IndexedDB Wrapper
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
### Features
2020-09-19 21:38:26 +00:00
2020-09-20 01:27:53 +00:00
- No Build Process Required
- Progressive Web App
## Quick Start
2020-09-20 02:12:48 +00:00
`npm start` Runs the app in the development mode using `live-server`. By default. Your browser should open to `http://localhost:8080`.
2020-09-20 01:27:53 +00:00
2020-09-20 02:12:48 +00:00
> live-server reloads just rock for development.
2020-09-20 01:27:53 +00:00
2020-09-20 02:12:48 +00:00
## TODO
2020-09-20 01:27:53 +00:00
2020-09-20 02:12:48 +00:00
- Integrate `frontend-dependencies` or `Parcel` for vendor lib management
- Add ability to add entries/details to catalog/entries from modal
- Add ability to change dates back and forward on date line
- Add ability to load date based on date picker
2020-09-20 01:27:53 +00:00
## Support
Please open [an issue](https://github.com/n2geoff/fast-calorie/issues/new) for support.
## Contributing
Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the [guidelines](CONTRIBUTING.md), they're minimalistic;)
## License
[MIT](LICENSE)