Skip to content

Commit b6e9a3d

Browse files
authored
Update README.md
1 parent d960e66 commit b6e9a3d

1 file changed

Lines changed: 124 additions & 10 deletions

File tree

README.md

Lines changed: 124 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,130 @@
1-
# ondaum
21

3-
A new Flutter project.
2+
# Ondaum application - App
3+
> Hello👋 This is team Ondaum. ***Ondaum*** is a pure Korean word, meaning ***'a warm and genuine self'***.
44
5-
## Getting Started
5+
![Flutter](https://img.shields.io/badge/Flutter-%2302569B.svg?style=for-the-badge&logo=Flutter&logoColor=white)
6+
![Dart](https://img.shields.io/badge/dart-%230175C2.svg?style=for-the-badge&logo=dart&logoColor=white)
7+
![Google Gemini](https://img.shields.io/badge/google%20gemini-8E75B2?style=for-the-badge&logo=google%20gemini&logoColor=white)
68

7-
This project is a starting point for a Flutter application.
9+
## 🌍 OVERVIEW
10+
We want to help people around the world live healthier lives by being with Um, an AI professional psychological counseling companion, anytime and anywhere.
811

9-
A few resources to get you started if this is your first Flutter project:
12+
In the past year, 73.6% of Korean young adults experienced mental health challenges. In addition, global statistics reveal that 66% of individuals aged 18-24 report experiencing moderate to severe.
1013

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
14+
Ondaum provides accessible, mental health support anytime, anywhere, reducing financial and stigma barriers.
The chatbot analyzes conversations in real time to detect risk signals and offer timely support, while its friendly interface keeps users engaged and lowers resistance.
1315

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
16+
Let's start https://ondaum.revimal.me/
17+
18+
#### 📱 FEATURES
19+
- AI Counseling With Um
20+
- Personalized Psychological Assessments & Real-Time Crisis Response
21+
- Psychological Assessments
22+
- International standard tests(PHQ-9 / GAD-7 / PSS)
23+
- Deliver tailored insights and links to support upon risk detection
24+
- AI Analysis of Conversation Content
25+
- Summary and organization of the conversation
26+
- extracting key emotions and keywords
27+
- visualize the recommends using charts
28+
29+
#### ✨ VALUES
30+
- Available for consultation anytime, anywhere
31+
- Personalized consultation possible
32+
- Reduced barriers to seeking counseling
33+
- Access to a pre-trained professional psychological counseling AI
34+
35+
## 🛠 SKILLS
36+
- **Web**: React, Typescript, Zustand, WebSocket, TailwindCSS
37+
- **Mobile**: Flutter, Dart
38+
- **AI**: Gemini-2.5-Pro
39+
- **Auth**: Google Oauth, jwt
40+
- **Bundler**: Vite,
41+
- **Package Manager**: NPM
42+
- **Logging System**: Google Analytics
43+
44+
## 🏛️ CLIENT ARCHITECTURE
45+
```mermaid
46+
graph TD
47+
Web[Web]
48+
iOS[iOS]
49+
Android[Android]
50+
Ondaum[ondaum-client]
51+
Flutter[ondaum-application]
52+
53+
Flutter --> iOS
54+
Flutter --> Android
55+
Ondaum --> Web
56+
Ondaum --> Flutter
57+
```
58+
59+
## 📁 DIRECTORY
60+
```
61+
src/
62+
├── api/ # server API list
63+
│ ├── auth
64+
│ ├── chat
65+
│ ├── onboarding
66+
│ ├── report
67+
│ └── test
68+
├── assets/ # static assets
69+
│ ├── images
70+
│ └── lotties
71+
├── commons/ # common components (like metaial UI)
72+
│ ├── data-display
73+
│ ├── feedback
74+
│ ├── inputs
75+
│ ├── mui-x/DatePickers
76+
│ ├── navigation
77+
│ └── surfaces
78+
├── hooks/ # custom hooks
79+
├── services/ # service components
80+
│ ├── auth
81+
│ ├── error
82+
│ ├── home
83+
│ ├── onboarding
84+
│ ├── report
85+
│ └── setting
86+
├── styles/ # reset css
87+
├── store/ # zustand store
88+
│ ├── auth
89+
│ ├── chat
90+
│ ├── keyboard
91+
│ └── onboarding
92+
```
93+
94+
## 🚀 INSTALLATION
95+
96+
1. Intsall Flutter
97+
```bash
98+
git clone https://github.com/flutter/flutter.git -b stable
99+
echo 'export PATH="$PATH:$HOME/flutter/bin"' >> ~/.zshrc
100+
source ~/.zshrc
101+
flutter --version
102+
```
103+
104+
2-1. Run Android
105+
```bash
106+
flutter run
107+
flutter run -d emulator-5554
108+
```
109+
110+
2-2. Run iOS
111+
```bash
112+
flutter pub get
113+
cd ios
114+
pod install
115+
116+
//xcode 열기
117+
ios/Runner.xcworkspace
118+
```
119+
120+
## 🖥️ SCREENS
121+
122+
| |
123+
|:--:|
124+
| <img width="543" alt="image" src="https://github.com/user-attachments/assets/fb658963-0ce9-46b9-b7b0-ca5014c4156d" /> |
125+
| <img width="540" alt="image" src="https://github.com/user-attachments/assets/5b469fb4-a23b-4e9c-b432-75d81669a94e" /> |
126+
| <img width="881" alt="image" src="https://github.com/user-attachments/assets/d931f45b-afc1-49bb-8481-96ccbce65b3a" /> |
127+
| <img width="313" alt="image" src="https://github.com/user-attachments/assets/95f52feb-708f-4112-a668-5b4eada0990d" /> |
128+
129+
130+
📅 This README was written on **May 15, 2025**.

0 commit comments

Comments
 (0)