Delete README.md
Browse files
README.md
DELETED
@@ -1,370 +0,0 @@
|
|
1 |
-
[](https://huggingface.co/spaces/mrradix/mona)
|
2 |
-
[](https://opensource.org/licenses/MIT)
|
3 |
-
[](https://www.python.org/downloads/)
|
4 |
-
[](https://gradio.app/)
|
5 |
-
|
6 |
-
> **The Complete AI Productivity OS - Built Entirely with FREE Hugging Face Resources**
|
7 |
-
|
8 |
-
MONA is a comprehensive AI-powered productivity operating system that brings together task management, note-taking, goal planning, AI assistance, and advanced analytics in one unified platform. Best of all, it's built entirely using free Hugging Face models and resources!
|
9 |
-
|
10 |
-
## ๐ Live Demo
|
11 |
-
|
12 |
-
**Try MONA now:** https://huggingface.co/spaces/mrradix/mona
|
13 |
-
|
14 |
-
## ๐ Table of Contents
|
15 |
-
|
16 |
-
- [โจ Key Features](#-key-features)
|
17 |
-
- [๐ ๏ธ Technology Stack](#๏ธ-technology-stack)
|
18 |
-
- [๐ฎ Advanced Features](#-advanced-features)
|
19 |
-
- [๐ผ๏ธ Vision & Media Processing](#๏ธ-vision--media-processing)
|
20 |
-
- [๐ค Voice & Audio](#-voice--audio)
|
21 |
-
- [๐ Smart Integrations](#-smart-integrations)
|
22 |
-
- [๐ Telegram Integration](#-telegram-integration)
|
23 |
-
- [๐ฎ Gamification Elements](#-gamification-elements)
|
24 |
-
- [โ๏ธ Settings & Customization](#๏ธ-settings--customization)
|
25 |
-
- [๐ Innovation & Cutting-Edge Features](#-innovation--cutting-edge-features)
|
26 |
-
- [๐ Technical Implementation](#-technical-implementation)
|
27 |
-
- [๐ Security & Privacy](#-security--privacy)
|
28 |
-
- [๐ง Installation](#-installation)
|
29 |
-
- [๐โโ๏ธ Getting Started](#๏ธ-getting-started)
|
30 |
-
- [๐ Usage Guide](#-usage-guide)
|
31 |
-
- [๐งฉ Project Structure](#-project-structure)
|
32 |
-
- [๐ค Contributing](#-contributing)
|
33 |
-
- [๐ License](#-license)
|
34 |
-
|
35 |
-
## โจ Key Features
|
36 |
-
|
37 |
-
### ๐ **Unified Dashboard**
|
38 |
-
- Today's focus widget with AI motivation
|
39 |
-
- Real-time activity feed and progress tracking
|
40 |
-
- Smart deadline management and streak counters
|
41 |
-
- Weather integration and daily planning
|
42 |
-
|
43 |
-
### ๐ **Advanced Task Management**
|
44 |
-
- Multiple views: Kanban, List, Calendar, Timeline
|
45 |
-
- AI-powered task breakdown and time estimation
|
46 |
-
- Smart categorization with NLP
|
47 |
-
- Dependency mapping and bulk operations
|
48 |
-
|
49 |
-
### ๐ **Notion-Style Notes & Documents**
|
50 |
-
- Block-based rich text editor
|
51 |
-
- Database tables with sorting and filtering
|
52 |
-
- Template library with 50+ pre-built templates
|
53 |
-
- AI writing assistant and auto-linking
|
54 |
-
|
55 |
-
### ๐ฏ **Goal Setting & Planning**
|
56 |
-
- SMART goals framework
|
57 |
-
- Habit tracking with visual progress
|
58 |
-
- Weekly/monthly planning tools
|
59 |
-
- AI goal suggestions and reflection journal
|
60 |
-
|
61 |
-
### ๐ค **Multi-Modal AI Assistant Hub**
|
62 |
-
- General chat with DialoGPT
|
63 |
-
- Specialized assistants for productivity, writing, and code
|
64 |
-
- Voice-to-text with Whisper integration
|
65 |
-
- Image analysis with BLIP captioning
|
66 |
-
|
67 |
-
### ๐ **Intelligent Search & Discovery**
|
68 |
-
- Semantic search across all content
|
69 |
-
- AI-powered Q&A system
|
70 |
-
- Related content recommendations
|
71 |
-
- Advanced filtering and saved searches
|
72 |
-
|
73 |
-
### ๐ **Advanced Analytics**
|
74 |
-
- Interactive visualizations with Plotly
|
75 |
-
- Productivity metrics and time analysis
|
76 |
-
- Mood tracking and wellness insights
|
77 |
-
- Custom dashboards and reports
|
78 |
-
|
79 |
-
### ๐ง **Focus & Wellness Tools**
|
80 |
-
- Pomodoro timer with focus sessions
|
81 |
-
- Meditation timer and break reminders
|
82 |
-
- Stress monitoring and wellness insights
|
83 |
-
- Habit streak tracking
|
84 |
-
|
85 |
-
## ๐ ๏ธ Technology Stack
|
86 |
-
|
87 |
-
### AI Models (All Free from Hugging Face)
|
88 |
-
- **Text Generation**: `microsoft/DialoGPT-medium`
|
89 |
-
- **Question Answering**: `distilbert-base-uncased-distilled-squad`
|
90 |
-
- **Image Analysis**: `Salesforce/blip-image-captioning-base`
|
91 |
-
- **Speech-to-Text**: `openai/whisper-small`
|
92 |
-
- **Translation**: `Helsinki-NLP/opus-mt-en-de`
|
93 |
-
- **Sentiment Analysis**: `cardiffnlp/twitter-roberta-base-sentiment-latest`
|
94 |
-
- **Summarization**: `facebook/bart-large-cnn`
|
95 |
-
- **Code Generation**: `microsoft/CodeBERT-base`
|
96 |
-
|
97 |
-
### Framework & Infrastructure
|
98 |
-
- **Frontend**: Gradio with custom CSS/JS
|
99 |
-
- **Backend**: Python with Transformers
|
100 |
-
- **Storage**: JSON-based persistence
|
101 |
-
- **Hosting**: Hugging Face Spaces (Free!)
|
102 |
-
- **Charts**: Plotly for interactive visualizations
|
103 |
-
|
104 |
-
## ๐ฎ Advanced Features
|
105 |
-
|
106 |
-
### ๐ผ๏ธ **Vision & Media Processing**
|
107 |
-
- Image captioning and OCR text extraction
|
108 |
-
- QR code generation and document scanning
|
109 |
-
- Mind map creation and diagram tools
|
110 |
-
- Auto-categorization of visual content
|
111 |
-
|
112 |
-
### ๐ค **Voice & Audio**
|
113 |
-
- Speech-to-text for hands-free operation
|
114 |
-
- Voice notes and task dictation
|
115 |
-
- Audio transcription for meetings
|
116 |
-
- Text-to-speech for accessibility
|
117 |
-
|
118 |
-
### ๐ **Smart Integrations**
|
119 |
-
- GitHub issues and repository sync
|
120 |
-
- Calendar integration (Google, Outlook)
|
121 |
-
- Weather API for local forecasts
|
122 |
-
- Email integration for task creation
|
123 |
-
- Telegram Bot integration for notifications
|
124 |
-
|
125 |
-
### ๐ **Telegram Integration**
|
126 |
-
|
127 |
-
Mona offers a powerful Telegram bot integration that allows you to receive notifications and interact with your tasks, notes, and other features directly from Telegram.
|
128 |
-
|
129 |
-
#### Setting Up Telegram Integration
|
130 |
-
|
131 |
-
1. **Create a Telegram Bot**:
|
132 |
-
- Open Telegram and search for the "BotFather" (@BotFather)
|
133 |
-
- Send the command `/newbot` and follow the instructions to create a new bot
|
134 |
-
- Once created, BotFather will provide you with a **Bot Token** - save this for the next step
|
135 |
-
|
136 |
-
2. **Configure Mona with Your Bot Token**:
|
137 |
-
- In Mona, navigate to `โ๏ธ Settings` > `API Keys` tab
|
138 |
-
- Select "Telegram" from the dropdown menu
|
139 |
-
- Enter your Bot Token in the API Key field
|
140 |
-
- Click "Save API Key"
|
141 |
-
- Click "Test API Key" to verify the connection
|
142 |
-
|
143 |
-
3. **Get Your Chat ID**:
|
144 |
-
- Open your bot in Telegram and send the `/start` command
|
145 |
-
- This will register your chat with the bot and allow Mona to send you messages
|
146 |
-
|
147 |
-
#### Telegram Bot Features
|
148 |
-
|
149 |
-
Once connected, you can use the following commands with your Telegram bot:
|
150 |
-
|
151 |
-
- `/start` - Initialize the bot and get a welcome message
|
152 |
-
- `/help` - Display available commands and usage information
|
153 |
-
- `/tasks` - Get a list of your current tasks
|
154 |
-
- `/status` - Check the status of Mona and your integrations
|
155 |
-
- `/subscribe` - Subscribe to notifications (tasks, goals, daily summaries)
|
156 |
-
- `/unsubscribe` - Unsubscribe from notifications
|
157 |
-
|
158 |
-
You'll also receive notifications for:
|
159 |
-
- Task reminders
|
160 |
-
- Goal updates
|
161 |
-
- Daily summaries
|
162 |
-
- Important system notifications
|
163 |
-
|
164 |
-
> ๐ก **Pro Tip**: You can customize which notifications you receive in the Settings page under the Notifications tab.
|
165 |
-
|
166 |
-
### ๐ฎ **Gamification Elements**
|
167 |
-
- Achievement System - Unlock badges and rewards
|
168 |
-
- Productivity Streaks - Consistency challenges
|
169 |
-
- Level Progression - User advancement system
|
170 |
-
- Challenge Modes - Productivity competitions
|
171 |
-
- Social Features - Share achievements
|
172 |
-
- Leaderboards - Community rankings
|
173 |
-
- Reward Points - Virtual currency system
|
174 |
-
- Mission Quests - Guided productivity journeys
|
175 |
-
|
176 |
-
### โ๏ธ **Settings & Customization**
|
177 |
-
- Theme System - Light/dark modes
|
178 |
-
- Layout Customization - Drag-and-drop interface
|
179 |
-
- Notification Control - Granular settings
|
180 |
-
- Data Export - Complete data download
|
181 |
-
- Backup System - JSON file exports
|
182 |
-
- Language Support - Multi-language UI
|
183 |
-
- Accessibility - Screen reader support
|
184 |
-
- Keyboard Shortcuts - Power user features
|
185 |
-
|
186 |
-
### ๐ **Innovation & Cutting-Edge Features**
|
187 |
-
- AI-Powered Brainstorming - Creative idea generation
|
188 |
-
- Automatic Meeting Notes - Call transcription
|
189 |
-
- Smart Email Parsing - Extract tasks from emails
|
190 |
-
- Document Intelligence - Auto-extract insights
|
191 |
-
- Collaborative Filtering - Team recommendations
|
192 |
-
- Predictive Analytics - Future trend forecasting
|
193 |
-
- Natural Language Queries - Conversational search
|
194 |
-
- Contextual Computing - Environment-aware features
|
195 |
-
|
196 |
-
### ๐ **Technical Implementation**
|
197 |
-
- Hugging Face Spaces - Free hosting platform
|
198 |
-
- Gradio Interface - Python web framework
|
199 |
-
- Persistent Storage - JSON file system
|
200 |
-
- Real-time Updates - WebSocket connections
|
201 |
-
- Mobile Responsive - CSS Grid/Flexbox
|
202 |
-
- PWA Features - App-like experience
|
203 |
-
- Offline Capability - Service worker caching
|
204 |
-
- Performance Optimization - Lazy loading
|
205 |
-
|
206 |
-
### ๐ **Security & Privacy**
|
207 |
-
- Client-side Encryption - Browser-based security
|
208 |
-
- Data Anonymization - Privacy protection
|
209 |
-
- Secure Sessions - Token-based authentication
|
210 |
-
- GDPR Compliance - Privacy regulations
|
211 |
-
- Audit Logging - Security monitoring
|
212 |
-
- Access Controls - Permission management
|
213 |
-
- Data Validation - Input sanitization
|
214 |
-
- Error Handling - Graceful failure recovery
|
215 |
-
|
216 |
-
## ๐ง Installation
|
217 |
-
|
218 |
-
1. Clone the repository:
|
219 |
-
```bash
|
220 |
-
git clone https://github.com/mona-ai/mona.git
|
221 |
-
cd mona
|
222 |
-
```
|
223 |
-
|
224 |
-
2. Install dependencies:
|
225 |
-
```bash
|
226 |
-
pip install -r requirements.txt
|
227 |
-
```
|
228 |
-
|
229 |
-
3. Run the application:
|
230 |
-
```bash
|
231 |
-
python app.py
|
232 |
-
```
|
233 |
-
|
234 |
-
4. Open your browser and navigate to `http://localhost:7860`
|
235 |
-
|
236 |
-
## ๐โโ๏ธ Getting Started
|
237 |
-
|
238 |
-
### First-time Setup
|
239 |
-
|
240 |
-
1. Launch the application by running `python app.py`
|
241 |
-
2. Navigate to the Settings page (โ๏ธ) to configure your preferences
|
242 |
-
3. Set up your user profile with name, timezone, and language
|
243 |
-
4. Customize the appearance and notification settings
|
244 |
-
|
245 |
-
### Quick Tour
|
246 |
-
|
247 |
-
1. **Dashboard**: Your central hub with today's focus and quick stats
|
248 |
-
2. **Tasks & Projects**: Manage your to-dos with multiple views
|
249 |
-
3. **Notes & Docs**: Create and organize your notes and documents
|
250 |
-
4. **Goals & Planning**: Set and track your short and long-term goals
|
251 |
-
5. **AI Assistant Hub**: Access specialized AI assistants for various tasks
|
252 |
-
6. **Smart Search**: Find anything across your entire knowledge base
|
253 |
-
7. **Analytics**: Gain insights into your productivity patterns
|
254 |
-
8. **Focus & Wellness**: Track your focus sessions and mood
|
255 |
-
|
256 |
-
## ๐ Usage Guide
|
257 |
-
|
258 |
-
### Task Management
|
259 |
-
|
260 |
-
1. **Creating Tasks**:
|
261 |
-
- Click the "+ New Task" button on the Tasks page
|
262 |
-
- Fill in the title, description, priority, and deadline
|
263 |
-
- Optionally add tags, subtasks, and attachments
|
264 |
-
|
265 |
-
2. **Organizing Tasks**:
|
266 |
-
- Drag and drop tasks between columns in Kanban view
|
267 |
-
- Use filters to focus on specific priorities or tags
|
268 |
-
- Group tasks by project, priority, or status
|
269 |
-
|
270 |
-
3. **AI-Powered Features**:
|
271 |
-
- Use "AI Breakdown" to split complex tasks into subtasks
|
272 |
-
- Get time estimates based on task descriptions
|
273 |
-
- Receive smart categorization suggestions
|
274 |
-
|
275 |
-
### Note Taking
|
276 |
-
|
277 |
-
1. **Creating Notes**:
|
278 |
-
- Click the "+ New Note" button on the Notes page
|
279 |
-
- Use the rich text editor with markdown support
|
280 |
-
- Add tags for organization
|
281 |
-
|
282 |
-
2. **Advanced Features**:
|
283 |
-
- Create database tables within notes
|
284 |
-
- Use templates for common note types
|
285 |
-
- Link notes to tasks and goals
|
286 |
-
|
287 |
-
3. **AI Assistance**:
|
288 |
-
- Get writing suggestions and completions
|
289 |
-
- Generate summaries of long notes
|
290 |
-
- Analyze sentiment and key topics
|
291 |
-
|
292 |
-
### Using AI Models
|
293 |
-
|
294 |
-
1. **AI Assistant Hub**:
|
295 |
-
- Select the appropriate model for your task
|
296 |
-
- Provide clear instructions or questions
|
297 |
-
- Review and refine the AI-generated content
|
298 |
-
|
299 |
-
2. **Voice and Image Processing**:
|
300 |
-
- Upload images for captioning and analysis
|
301 |
-
- Record voice for transcription and task creation
|
302 |
-
- Convert text to speech for accessibility
|
303 |
-
|
304 |
-
## ๐งฉ Project Structure
|
305 |
-
|
306 |
-
```
|
307 |
-
mona/
|
308 |
-
โโโ app.py # Main application entry point
|
309 |
-
โโโ requirements.txt # Python dependencies
|
310 |
-
โโโ README.md # Project documentation
|
311 |
-
โโโ data/ # Data storage directory
|
312 |
-
โ โโโ tasks/ # Task data storage
|
313 |
-
โ โโโ notes/ # Notes data storage
|
314 |
-
โ โโโ goals/ # Goals data storage
|
315 |
-
โ โโโ settings.json # User settings
|
316 |
-
โ โโโ integrations.json # Integration configurations
|
317 |
-
โโโ pages/ # Gradio page components
|
318 |
-
โ โโโ dashboard.py # Dashboard page
|
319 |
-
โ โโโ tasks.py # Tasks & Projects page
|
320 |
-
โ โโโ notes.py # Notes & Docs page
|
321 |
-
โ โโโ goals.py # Goals & Planning page
|
322 |
-
โ โโโ ai_assistant.py # AI Assistant Hub page
|
323 |
-
โ โโโ search.py # Smart Search page
|
324 |
-
โ โโโ analytics.py # Analytics page
|
325 |
-
โ โโโ focus.py # Focus & Wellness page
|
326 |
-
โ โโโ multimedia.py # Multimedia page
|
327 |
-
โ โโโ integrations.py # Integrations page
|
328 |
-
โ โโโ settings.py # Settings page with API key management
|
329 |
-
โโโ utils/ # Utility modules
|
330 |
-
โโโ ai_models.py # AI model integrations
|
331 |
-
โโโ config.py # Application configuration
|
332 |
-
โโโ error_handling.py # Error handling utilities
|
333 |
-
โโโ logging.py # Logging configuration
|
334 |
-
โโโ state.py # Application state management
|
335 |
-
โโโ storage.py # Data storage utilities
|
336 |
-
โโโ ui_components.py # Reusable UI components
|
337 |
-
โโโ integrations/ # Integration modules
|
338 |
-
โโโ __init__.py # Integration initialization
|
339 |
-
โโโ weather.py # Weather API integration
|
340 |
-
โโโ telegram.py # Telegram Bot integration
|
341 |
-
โโโ github.py # GitHub integration
|
342 |
-
โโโ calendar.py # Calendar integration
|
343 |
-
โโโ email.py # Email integration
|
344 |
-
โโโ rss.py # RSS feed integration
|
345 |
-
โโโ news.py # News API integration
|
346 |
-
โโโ crypto.py # Cryptocurrency API integration
|
347 |
-
```
|
348 |
-
|
349 |
-
## ๐ค Contributing
|
350 |
-
|
351 |
-
Contributions are welcome! Here's how you can help:
|
352 |
-
|
353 |
-
1. **Report bugs**: Open an issue describing the bug and how to reproduce it
|
354 |
-
2. **Suggest features**: Open an issue describing your feature idea
|
355 |
-
3. **Submit pull requests**: Fork the repo, make changes, and submit a PR
|
356 |
-
|
357 |
-
### Development Guidelines
|
358 |
-
|
359 |
-
1. Follow the existing code style and organization
|
360 |
-
2. Add docstrings to all functions and classes
|
361 |
-
3. Write tests for new features
|
362 |
-
4. Update documentation as needed
|
363 |
-
|
364 |
-
## ๐ License
|
365 |
-
|
366 |
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
367 |
-
|
368 |
-
---
|
369 |
-
|
370 |
-
<p align="center">Built with โค๏ธ using <a href="https://huggingface.co/">Hugging Face</a> and <a href="https://gradio.app/">Gradio</a></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|