Skip to content

Commit 67a4cb5

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

File tree

5 files changed

+40
-6
lines changed

5 files changed

+40
-6
lines changed

README.md

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

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

12.2 MB
Loading

0 commit comments

Comments
 (0)