Calorie counter
This project represents simple web app to calculate calories based on given food type.
Please check https://food-calories-counter.herokuapp.com get familiar with application itself.
Tools
- front-end
- html5
- css3
- javascript (vanilla)
- back-end
- python 3.6 | 3.7 | 3.8
- flask
- code analysis
Usage
PYPI
Please run following script to obtain latest package from PYPI:
➜ pip install calorie-counter
Then please execute instructions below to launch game from your environment:
from counter import Bind, easyrun
easyrun(bind=Bind("0.0.0.0:5003"), debug=True)
Running on https://0.0.0.0:5003 (CTRL + C to quit)
...
Then please open localhost:5003/ endpoint.
Source code
To be able to run source code please execute command below:
➜ python -m counter --bind 0.0.0.0:5003 --debug
Running on https://0.0.0.0:5003 (CTRL + C to quit)
...
Also you can use flask built-in runner based on .flaskenv config file:
➜ flask run
Serving Flask app "counter.py"
...
For both cases, then please open localhost:5003/ endpoint.
Development notes
CI
Project has Travis CI integration using .travis.yml file thus code analysis (black
, mypy
) and unittests (pytest
) will be run automatically
after every made change to the repository.
To be able to run code analysis, please execute command below:
➜ ./analyse-code.sh
Release notes
- 0.1.3
- Use click CLI tool
- 0.1.2
- Add metainfo into home page
- 0.1.0
- Introduce PYPI package
Meta
Author – Volodymyr Yahello
Distributed under the MIT
license. See LICENSE for more information.
You can reach out me at:
- vyahello@gmail.com
- https://github.com/vyahello
- https://www.linkedin.com/in/volodymyr-yahello-821746127
Contributing
- clone the repository
- configure Git for the first time after cloning with your
name
andemail
-
pip install -r requirements.txt
to install all project dependencies -
pip install -r requirements-dev.txt
to install all dev project dependencies