/mcbroken_app

This repository includes a Flutter App to track the McDonald´s Ice Cream machines

Primary LanguageDartMIT LicenseMIT

mcbroken_app
Explore the screenshots »

Report a Bug · Request a Feature . Ask a Question

Project license

Pull Requests welcome code with love by PlaxXOnline

Table of Contents

About

Haven't you ever driven to a McDonalds on a hot summer day with a craving for ice cream? Or a McFlurry?

Yes?

Then one or the other of these trips was probably completely wasted because the ice cream machine was broken, right?

With this app, that's guaranteed not to happen again. With the brilliant idea of Rashiq to develop an API that programmatically checks if the ice machine of McDonalds is working, all these unnecessary empty trips are passeé. Rashiq only had a website available at the time of development, so I thought I'd give this project a cross platform app.

Screenshots
Machine is working Machine is not working
Clustering
SplashScreen
Actual Position

Built With

This Application was build with:

Getting Started

Installation

First, download and install Flutter. Then Clone the Repository:

git clone <https://github.com/PlaxXOnline/mcbroken_app.git>

Run

flutter pub get

Start your Simulator or connect your Smartphone and hit the run button.

Usage

If everything is successfully installed, you can just start your IDE and Simulator and press the run button.

Roadmap

  • Popups
  • Clustering
  • Settings
  • Localizations
  • Show Actual Position
    • Back to Actual Position
  • SplashScreen
  • Search
  • Support more Countries

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

Support

Project assistance

If you want to say thank you or/and support active development of mcbroken_app:

  • Add a GitHub Star to the project.
  • Tweet about the mcbroken_app.
  • Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make mcbroken_app better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Janik Kahle.

The mcbroken API is by Rashiq.

For a full list of all authors and contributors, see the contributors page.

Security

mcbroken_app follows good practices of security, but 100% security cannot be assured. mcbroken_app is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

A very special thanks goes to Rashiq, without his API and idea this would have been nowhere near as easy.