-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathsetup.sh
More file actions
117 lines (91 loc) · 2.34 KB
/
setup.sh
File metadata and controls
117 lines (91 loc) · 2.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
## Installation & Setup
### Prerequisites
| Requirement | Version | Purpose |
|-------------|---------|---------|
| Node.js | ≥18.0.0 | Runtime environment |
| npm | ≥8.0.0 | Package management |
| Python | ≥3.8 | Backend AI services |
| Ollama | Latest | Local AI
8000
model serving |
| ChromaDB | ≥0.5.15 | Vector database |
### Step-by-Step Installation
# **1. Install Ollama and Models**
```bash
# Install Ollama (macOS/Linux)
curl -fsSL https://ollama.ai/install.sh | sh
# Windows: Download from https://ollama.ai/download
# Install required models
ollama pull llama3
ollama pull nomic-embed-text
```
# **2. Clone and Setup Main Application**
```bash
# Clone the repository
git clone https://github.com/officiallyutso/chronicle.git
cd chronicle
# Install dependencies
npm install
# Run TypeScript for Electron
npm run dev:all
```
# **3. Setup Backend MicroServices**
```bash
# Navigate to backend directory
cd backend
# Install backend dependencies
npm install
# Start the backend server
npm run dev
```
# **4. Setup ChromaDB Vector Database**
```bash
# Install ChromaDB (in root dir)
pip install chromadb
# Start ChromaDB server
chroma run --host 0.0.0.0 --port 8000 --path ../chronicle_data
```
#
# **5. Install VS Code Extension**
```bash
# Navigate to VS Code extension directory
cd vs-code-extension
# Install dependencies
npm install
# Compile the extension
npm run compile
# Install in VS Code
# Method 1: Press F5 to run in development mode (preferred)
# Method 2: Package and install
vsce package
code --install-extension chronicle-*.vsix
```
# **6. Install Browser Extension**
**Chrome/Edge:**
1. Open `chrome://extensions/`
2. Enable "Developer mode"
3. Click "Load unpacked"
4. Select the `chronicle-browser-extension` folder
**Firefox:**
1. Open `about:debugging`
2. Click "This Firefox"
3. Click "Load Temporary Add-on"
4. Select `manifest.json` from the extension folder
# **7. Start the Complete System**
```bash
# Terminal 1: Start ChromaDB
chroma run --host 0.0.0.0 --port 8000 --path ./chronicle_data
# Terminal 2: Start Backend
cd backend && npm run dev
# Terminal 3: Start Desktop App
npm run dev:all
```
---
## Advanced Configuration
### Environment Variables
```bash
# Backend Configuration (.env)
PORT=3001
OLLAMA_BASE_URL=http://localhost:11434
CHROMA_URL=http://localhost:8000
EMBEDDING_MODEL=nomic-embed-text
CHAT_MODEL=llama3
```