This commit is contained in:
Geoff Doty 2020-09-19 21:27:53 -04:00
parent 21d61726c9
commit bd8f6e8a69
3 changed files with 128 additions and 14 deletions

70
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,70 @@
# Contributing
So you want to contribute, nice. **Thank you**.
Bug reports and code and documentation patches are all welcome. You can help this project also by using the development version and by reporting any bugs you might encounter.
You may contribute in several ways like:
* Creating new features
* Fixing bugs
* Improving documentation and examples
* Translating any document here to your language
## Table of contents
* [Contributing](#contributing)
* [Developing](#developing)
* [Running tests](#running-tests)
* [Reporting a bug](#reporting-a-bug)
* [Request a feature](#request-a-feature)
* [Commit message](#commit-message)
* [Code style](#code-style)
## Developing
The core logic is essentially a single source file in the project. It is the [/public/js/index.js](/public/js/index.js).
The [test/index.spec.js](test/index.spec.js) is for now the only unit test file in the project.
## Running tests
Run unit tests using this command:
```bash
npm run test
```
## Reporting a bug
Use the [Issue Tracker](http://code.negative9.net/geoff/fast-calorie.git/issues) to report any bug you find.
Bugs description should include:
* How to reproduce the bug;
* Easy to understand title;
Would be nice to have some code showing how to reproduce the code, you may use [gist](https://gist.github.com) or [Codepen](https://codepen.io) for uploading your example code.
## Request a feature
Use the [Issue Tracker](http://code.negative9.net/geoff/fast-calorie.git/issues) to request a new feature.
Keep in mind, this is a pure native web tech app: HTML, CSS, JS
## Commit message
Commit messages should includes issue number reference and a imperative easy to understand sentence.
## Coding style
If it is supported in all major browers without transpiling, then please use those JavaScript language features in your code, with one caveat -- readablity is king.
Currently all ES5 and ES6/ES2015 are available.
This project is linted agaist [ESLint](https://eslint.org/) and the [`.eslintrc.json`](.eslintrc.json) is dead-simple, and all you need to followed.
Thank you for reading this.
Hey, **star** this *repo* and/or share it with your friends.

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2020 Geoff Doty
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -1,24 +1,49 @@
# New Project
# Fast Calorie
> Single-Page Progressive Web App
> ✨ Bootstrapped with Create Snowpack App (CSA).
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.
## Available Scripts
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!
### npm start
This is YOUR app, your CALORIES, and your DATA!
Runs the app in the development mode.
Open http://localhost:8080 to view it in the browser.
## Development
The page will reload if you make edits.
You will also see any lint errors in the console.
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!
### npm run build
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
Builds a static copy of your site to the `build/` folder.
Your app is ready to be deployed!
### Stack
**For the best production performance:** Add a build bundler plugin like "@snowpack/plugin-webpack" or "@snowpack/plugin-parcel" to your `snowpack.config.json` config file.
- [Litedom JS](https://litedom.js.org/) - A Tiny View Library
- [Matrialize CSS](https://materializecss.com/) - A Not so Tiny CSS Framework
- [DexieDB] - A Robust IndexedDB Wrapper
- [Snowpack] - Fontend Build Tool, barily utilized
### Q: What about Eject?
### Features
No eject needed! Snowpack guarantees zero lock-in, and CSA strives for the same.
- No Build Process Required
- Progressive Web App
## Quick Start
`npm start` Runs the app in the development mode. By default you can open at http://localhost:8080 in your browser to view.
Your page will reload if you make edits. You will also see any lint errors in the console.
`npm run build` will build a static copy of your site in the `build/` folder, and thats it --your app is ready to be deployed!
> SEE: [snowpack.dev](https://www.snowpack.dev/) for more options
## 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)