Skip to content

Commit d824e98

Browse files
authored
docs: Add README file and MIT license (#3)
* refactor: Apply clean architecture (#2) * docs(readme): Add README file * Create LICENSE
1 parent 82d8540 commit d824e98

2 files changed

Lines changed: 65 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Jorge Sanz, Naufal Aros and Miguel Rojo
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
11
# 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

Comments
 (0)