|
1 | 1 | # Bizzy Cards for Android |
| 2 | +Welcome to Bizzy Cards' open source Android app! |
| 3 | + |
| 4 | +## Content |
| 5 | +- [About Bizzy Cards - Website](https://bizzycards.github.io) |
| 6 | +- [Development](#development) |
| 7 | +- Design |
| 8 | + - [Figma document](https://www.figma.com/file/KionIqUJy75l43IRbfQp9zKn/Bizzy-Cards) |
| 9 | + - [Figma interactive prototype](https://www.figma.com/proto/KionIqUJy75l43IRbfQp9zKn/Bizzy-Cards?scaling=contain&node-id=1%3A3) |
| 10 | +- [Features](#features) |
| 11 | +- [Technical implementation](#technical-documentation) |
| 12 | +- [Authors](https://github.com/jorge-sanz/bizzy-cards-android/graphs/contributors) |
| 13 | +- [License]() |
| 14 | +- [Acknowledgments](#acknowledgments) |
| 15 | + |
| 16 | +## Development |
| 17 | +### Getting started |
| 18 | +Follow the next steps to get the project ready for development: |
| 19 | +1. Clone this repository. |
| 20 | +2. Download the appropriate [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for your system. We are currently on JDK 8. |
| 21 | +3. [Install Android Studio](https://developer.android.com/sdk/index.html). |
| 22 | +4. Import the project. Open Android Studio, click `Open an existing Android Studio project` and select the project. Gradle will build the project. |
| 23 | +5. Run the app. Click `Run > Run 'app'`. After the project builds you'll be prompted to build or launch an emulator. |
| 24 | + |
| 25 | +## Features |
| 26 | +Project and product management is done on [out Trello board](https://trello.com/b/qXWG60vh). App features: |
| 27 | + |
| 28 | +- [ ] Add new card via QR code. |
| 29 | +- [ ] Show your QR code. |
| 30 | +- [ ] Edit your personal card. |
| 31 | +- [ ] Card list. |
| 32 | +- [ ] Detailed card view. |
| 33 | +- [ ] Get people's avatar automatically from Gravatar. |
| 34 | +- [ ] Send your card via NFC. |
| 35 | +- [ ] Receive new card via NFC. |
| 36 | +- [ ] Share other people's card. |
| 37 | + |
| 38 | +## Technical documentation |
| 39 | +### Architecture |
| 40 | +Bizzy Cards for Android is implemented following [the recommended app architecure by Google](https://developer.android.com/topic/libraries/architecture/guide.html#recommended_app_architecture) using the new [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html). |
| 41 | + |
| 42 | +## Acknowledgements |
| 43 | +- [fab-speed-dial](https://github.com/yavski/fab-speed-dial) |
| 44 | +- [barcodescanner](https://github.com/dm77/barcodescanner) |
| 45 | +- [Google Codelabs - Android Room with a View](https://codelabs.developers.google.com/codelabs/android-room-with-a-view/index.html?index=..%2F..%2Findex#0) |
0 commit comments