Skip to content
This repository has been archived by the owner on Nov 28, 2021. It is now read-only.

Mahaoqu/CalorieTracker

Repository files navigation

CalorieTracker

GitHub Repo stars DOI API Codacy Badge Workflow GitHub Licence GitHub top language GitHub issues GitHub contributors


Logo

CalorieTracker

"An excellent application which helps you to track daily calorie intake."
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This app is designed for recording daily calorie intake, it will help people living a healthier life:sweat_smile:

Built With

Getting Started

You can choose to run CalorieTracker on the Android Emulator either on a real android device.

Prerequisites

Android Emulator embedded in Android Studio or a real android device.

Installation

  • From Git:
  1. Clone the repo
    git clone https://github.com/Mahaoqu/CalorieTracker.git
  2. Open the local repo with Android Studio
  3. Find 'Run' menu and then click 'Run app'
  • From apk file:

    Download the apk file here and install it on your android device

Usage

This app has three basic functions now, more features are on the way!

  • BMI caculating:

    App could caculate user's BMI from the profile data

    image
  • Add new meal:

    Users could input meal record by clicking "+ New Meal" button

    image
  • Edit your profile:

    Users could edit their profile by clicking "Editing Your Profile"

    image

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Mahaoqu/CalorieTracker

Acknowledgements