Update README.md
Browse files
README.md
CHANGED
|
@@ -1,5 +1,58 @@
|
|
| 1 |
|
|
|
|
|
|
|
| 2 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
|
| 4 |
|
| 5 |
|
|
|
|
| 1 |
|
| 2 |
+
```markdown
|
| 3 |
+
# TaskMate
|
| 4 |
|
| 5 |
+
A simple task management application built with Python, Gradio, and Firebase.
|
| 6 |
+
|
| 7 |
+
## Features
|
| 8 |
+
- Add tasks with timestamps
|
| 9 |
+
- List all tasks with status
|
| 10 |
+
- Chat-like interface
|
| 11 |
+
- Firebase backend storage
|
| 12 |
+
|
| 13 |
+
## Prerequisites
|
| 14 |
+
- Python 3.x
|
| 15 |
+
- Firebase project
|
| 16 |
+
- `firebase-key.json` credentials file
|
| 17 |
+
|
| 18 |
+
## Installation
|
| 19 |
+
|
| 20 |
+
1. Clone repository
|
| 21 |
+
2. Install dependencies:
|
| 22 |
+
```bash
|
| 23 |
+
pip install -r requirements.txt
|
| 24 |
+
```
|
| 25 |
+
3. Setup Firebase:
|
| 26 |
+
- Create Firebase project
|
| 27 |
+
- Enable Firestore database (Native mode)
|
| 28 |
+
- Download credentials JSON as `firebase-key.json`
|
| 29 |
+
- Place in project root
|
| 30 |
+
|
| 31 |
+
## Usage
|
| 32 |
+
1. Run application:
|
| 33 |
+
```bash
|
| 34 |
+
python app.py
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
2. Commands:
|
| 38 |
+
- `/task [description]` - Add new task
|
| 39 |
+
- `/list` - View all tasks
|
| 40 |
+
|
| 41 |
+
## Environment Variables
|
| 42 |
+
Create `.env` file:
|
| 43 |
+
```
|
| 44 |
+
FIREBASE_KEY_PATH=firebase-key.json
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
## Tech Stack
|
| 48 |
+
- Gradio - UI interface
|
| 49 |
+
- Firebase - Database
|
| 50 |
+
- python-dotenv - Environment management
|
| 51 |
+
|
| 52 |
+
## Security
|
| 53 |
+
- Keep `firebase-key.json` secure
|
| 54 |
+
- Don't commit credentials
|
| 55 |
+
```
|
| 56 |
|
| 57 |
|
| 58 |
|