Skip to content

Commit cfd8486

Browse files
committed
Create README.md
1 parent 25f3ec6 commit cfd8486

7 files changed

+44
-6
lines changed

README.md

+44-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,46 @@
1-
# Gemini Demo App
1+
# Gemini Android
22

3-
**Goals**
3+
| Chat | Take picture | Pick images |
4+
|------------------------|----------------------------------------|--------------------------------------|
5+
| ![chat](docs/chat.gif) | ![take_picture](docs/take_picture.gif) | ![pick_images](docs/pick_images.gif) |
46

5-
- [ ] Improving reusability and scalability by using modularization
6-
- [ ] Supporting the wearable OS
7-
- [ ] Supporting talk to chat
8-
- [ ] Adapting to diverse display sizes, including tablets and foldable devices.
7+
| Regenerate | Select response |
8+
|------------------------------------|----------------------------------------------|
9+
| ![regenerate](docs/regenerate.gif) | ![select-response](docs/select_response.gif) |
10+
11+
## How to run?
12+
13+
1. [Create a Gemini API key](https://ai.google.dev/gemini-api/docs/api-key).
14+
2. Create a `secrets.properties` file in a root directory.
15+
3. Setup the API key in the `secrets.properties`.
16+
```properties
17+
GEMINI_API_KEY=YOUR_API_KEY
18+
```
19+
4. Build and run the App.
20+
21+
## Features
22+
23+
- Chat with **Gemini AI** using text messages and images.
24+
- Save chat history in the local database using Android Room.
25+
- (Upcoming) Support for Wear OS integration.
26+
27+
## Tech stacks
28+
29+
- 100% Jetpack Compose based + Coroutines + Flow for asynchronous.
30+
- Gemini SDK
31+
- Jetpack
32+
- Compose
33+
- ViewModel
34+
- Hilt
35+
- Room
36+
- Glide
37+
- Robolectric
38+
39+
## Architecture
40+
41+
Gemini Android follows the
42+
[Google's official architecture guidance](https://developer.android.com/topic/architecture)
43+
44+
## ERD
45+
46+
![erd](docs/erd.png)

docs/chat.gif

14.9 MB
Loading

docs/erd.png

38.4 KB
Loading

docs/pick_images.gif

7.89 MB
Loading

docs/regenerate.gif

4.94 MB
Loading

docs/select_response.gif

12.2 MB
Loading

docs/take_picture.gif

9.89 MB
Loading

0 commit comments

Comments
 (0)