Skip to content

Commit 8d8d125

Browse files
committed
Update readme and add missing .env.example
1 parent 5b18e4f commit 8d8d125

File tree

3 files changed

+54
-32
lines changed

3 files changed

+54
-32
lines changed

.gitignore

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,61 @@
1-
# Dependencies
1+
# dependencies
22
node_modules/
3-
venv/
4-
__pycache__/
3+
/.pnp
4+
.pnp.js
5+
6+
# testing
7+
/coverage
8+
9+
# production
10+
/build
11+
/dist
512

6-
# Environment files
13+
# Environment variables
714
.env
815
.env.local
916
.env.development.local
1017
.env.test.local
1118
.env.production.local
19+
.env*.local
1220

13-
# Build outputs
14-
/build
15-
/dist
16-
*.pyc
17-
18-
# IDE and OS files
19-
.idea/
20-
.vscode/
21-
.DS_Store
21+
# Python
22+
__pycache__/
23+
*.py[cod]
24+
*$py.class
25+
*.so
26+
.Python
27+
env/
28+
venv/
29+
ENV/
30+
build/
31+
develop-eggs/
32+
dist/
33+
downloads/
34+
eggs/
35+
.eggs/
36+
lib/
37+
lib64/
38+
parts/
39+
sdist/
40+
var/
41+
*.egg-info/
42+
.installed.cfg
43+
*.egg
2244

2345
# Logs
46+
logs
47+
*.log
2448
npm-debug.log*
2549
yarn-debug.log*
2650
yarn-error.log*
27-
*.log
51+
52+
# IDE
53+
.idea/
54+
.vscode/
55+
*.swp
56+
*.swo
57+
.DS_Store
58+
59+
# Database
60+
*.db
61+
*.sqlite3

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,10 @@ Current:
1313

1414
Planned:
1515
- 🧠 Multiple LLM integrations (GPT-4, Claude, Llama)
16-
- 🎤 Voice interactions
17-
- 🎨 Image generation and analysis
1816
- 📄 Document processing (RAG)
1917
- 📚 Custom knowledge base integration
2018
- 🔄 Multi-modal conversations
2119
- 💾 Conversation memory and context
22-
- 🔌 Plugin system
23-
- 📊 Analytics dashboard
24-
- ⚡ Fine-tuning capabilities
2520

2621
## Prerequisites
2722

@@ -63,29 +58,19 @@ ConversAI-Kit/
6358
The UI will be available at http://localhost:3000
6459

6560
### Backend (chatbot-api)
66-
1. Navigate to the backend directory:
61+
1. Create and activate a virtual environment:
6762
```bash
6863
cd chatbot-api
69-
```
70-
71-
2. Create and activate a virtual environment (recommended):
72-
```bash
7364
python -m venv venv
7465
source venv/bin/activate # On Windows: venv\Scripts\activate
7566
```
7667

77-
3. Install dependencies:
68+
2. Install dependencies:
7869
```bash
7970
pip install -r requirements.txt
8071
```
8172

82-
4. Set up environment variables:
83-
```bash
84-
cp .env.example .env
85-
# Edit .env with your OpenAI API key and other configurations
86-
```
87-
88-
5. Start the server:
73+
3. Start the server:
8974
```bash
9075
python app.py
9176
```

chatbot-api/.env.example

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# OpenAI Configuration
2+
OPENAI_API_KEY=your-api-key-here
3+
OPENAI_API_BASE=your-api-base-here

0 commit comments

Comments
 (0)