Skip to content
This repository has been archived by the owner on Jun 23, 2022. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benoitletondor committed Jun 3, 2018
1 parent b2bbbc5 commit b12fb64
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 5 deletions.
48 changes: 43 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,46 @@
# beer_me_up
# Beer Me Up

An app about beers
Beer Me Up is an iOS and Android app build with Flutter.

## Getting Started
The app is a personal beer logging that allows you to enter every beer you have to be sure to remember them forever.

For help getting started with Flutter, view our online
[documentation](https://flutter.io/).
<p align="center">
<img src="https://github.com/benoitletondor/Beer-Me-Up/raw/develop/sc1.png" width="250"/>
<img src="https://github.com/benoitletondor/Beer-Me-Up/raw/develop/sc2.png" width="250"/>
<img src="https://github.com/benoitletondor/Beer-Me-Up/raw/develop/sc3.png" width="250"/>
</p>

### Download the app

<p align="center">
<a href='https://play.google.com/store/apps/details?id=com.benoitletondor.beermeup'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' width="170"/></a>
</p>

### Motivations

This project is born as a technical playground to learn Flutter.

This project does not aim to be revolutionnary or even useful, it's just a simple app for people who love beers.

### Technical details

The app is made with Flutter with the following tech stack:
- Flutter: [https://flutter.io/](https://flutter.io/)
- FlutterFire: [https://github.com/flutter/plugins/blob/master/FlutterFire.md](https://github.com/flutter/plugins/blob/master/FlutterFire.md)
- Sentry.io: [https://sentry.io](https://sentry.io)

The app uses the MVI architecture, the implementation is greatly inspired by [Brian Egan's work](https://gitlab.com/brianegan/flutter_mvi_counter).

### Data provider

Beers data is coming from the [Untappd API](https://untappd.com/api)

<p align="center">
<img src="https://github.com/benoitletondor/Beer-Me-Up/raw/develop/pbu_80_yellow.png"/>
</p>

### Copyright

Copyright (C) 2018 Benoit LETONDOR. The name "Beer Me Up", the app idea and assets (images, names, wordings etc...) are all under copyright.

Sources are availables under the Apache 2 licence (See LICENSE for details) and contributions will be warmely welcomed!
Binary file added pbu_80_yellow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sc1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sc2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sc3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b12fb64

Please sign in to comment.