bmi_calculator_app/README.md
2021-07-04 09:40:42 +02:00

88 lines
2.3 KiB
Markdown

# BMI Calculator
Compute and track your Body Mass Index and Body Fat Percentage
## TODO
- [ ] bmi between 18.5 and 25 : green - normal
- [ ] bmi below 18.5 : pink - too skinny
- [ ] bmi between 25 and 30 : yellow - overweight
- [ ] bmi between 30 and 40 : orange - obesity
- [ ] bmi over 40 : red - morbid obesity
- [ ] bmi tracker: date, value, graph
- [ ] profile: save age, height, genre, local storage
- [x] bmi on second screen
- [x] feedback on genre select
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
You need a recent version of Flutter. Please follow installation steps for your platform from the official [documentation](https://flutter.dev/docs/get-started/install).
### Installing
Clone the repository using
```shell
git clone https://github.com/rjNemo/bmi_calculator_app.git
```
And run the development application with
```shell
flutter run
```
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
```shell script
Give an example
```
### And coding style tests
Explain what these tests test and why
```shell script
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
- [Flutter](https://flutter.dev/) - Beautiful native apps in record time
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/rjNemo/bmi_calculator_app/tags).
## Authors
- **Ruidy** - _Initial work_ - [Ruidy](https://github.com/rjNemo)
See also the list of [contributors](https://github.com/rjNemo/bmi_calculator_app/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
- [doc](https://www.santepratique.fr/nutrition/calcul-imc)
- [design inspiration](https://dribbble.com/shots/13913052-DailyUI-004-Calculator)