Update README.md

This commit is contained in:
Hardik Sankhla
2025-06-27 07:56:17 +05:30
parent 53f976c0b8
commit 886cc27955

View File

@@ -60,6 +60,64 @@ OLLAMA_API_URL=http://localhost:11434/api/generate
--- ---
## 🛠️ Getting Started
### ✅ Prerequisites
- Docker & Docker Compose installed
- Ports `8000` (API) and `11434` (Ollama) available
- At least 8GB RAM recommended
---
## 📦 Installation & Setup
### 1. Clone the Repository
```bash
git clone https://github.com/yourusername/timecraft-backend.git
cd timecraft-backend/backend
```
### 2. Create .env File
Update environment variables:
```bash
cp .env
```
Or manually create .env with the following content:
```bash
FRONTEND_URL=http://localhost:3000
LLM_PROVIDER=OLLAMA
OLLAMA_MODEL_NAME=qwen:4b
OLLAMA_API_URL=http://localhost:11434/api/generate
```
### 3. Start Services with Docker
```bash
docker-compose up -d --build
```
This will:
- Build and run the FastAPI backend
- Launch Ollama and ensure the LLM is ready
### 4. Pull the Required Model (One-Time)
```bash
docker exec ollama ollama pull qwen:4b
```
Once the model is pulled, it will persist in the Ollama volume.
---
## 📅 Weekly Task Schedule Visualization (Sample Week: July 14–20, 2025) ## 📅 Weekly Task Schedule Visualization (Sample Week: July 14–20, 2025)
| Time | Mon (14) | Tue (15) | Wed (16) | Thu (17) | Fri (18) | Sat (19) | Sun (20) | | Time | Mon (14) | Tue (15) | Wed (16) | Thu (17) | Fri (18) | Sat (19) | Sun (20) |