Skip to content

getting_started.md

Latest commit

 

History

History
124 lines (87 loc) · 3 KB

getting_started.md

File metadata and controls

124 lines (87 loc) · 3 KB

🚀 Getting Started

System Requirements

Requirement Minimum
OS Windows 10+, macOS 12+, Ubuntu 20.04+
Python 3.11+ (for development only)
Node.js 18+ (for Electron development only)
RAM 4 GB (8 GB recommended for local LLM)
Disk 500 MB (2 GB with Ollama models)

Option 1: Desktop App (Recommended)

No Python or Node.js required — everything is bundled into a single installer.

Download

Platform File Install
Windows Vera-Setup.exe Run the installer
macOS Vera.dmg Open DMG → drag to Applications
Linux Vera.AppImage chmod +x Vera-*.AppImage && ./Vera-*.AppImage

First Launch

  1. Launch the app — it will show a splash screen while the backend starts
  2. The main window opens automatically at localhost:8000
  3. Type or speak to start interacting with Vera

Global Shortcut

Press Ctrl+Shift+V to toggle the Vera window from anywhere.

Option 2: From Source (Developer)

Clone and Install

git clone https://github.com/patchava-sr/eVera.git
cd eVera
python -m venv .venv

# Activate virtual environment
# Linux/macOS:
source .venv/bin/activate
# Windows:
.venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

Configure API Keys

cp .env.example .env

Edit .env and add your API keys:

# Required: at least one LLM provider
VERA_LLM_OPENAI_API_KEY=sk-your-key-here
VERA_LLM_GEMINI_API_KEY=your-gemini-key

# Optional: local Ollama (free, no API key)
VERA_LLM_OLLAMA_URL=http://localhost:11434
VERA_LLM_OLLAMA_MODEL=llama3.2

# Optional: API security
VERA_SERVER_API_KEY=my-secret-key

Run

# Start the server
python main.py --mode server

# Open http://localhost:8000 in your browser

Run with Electron (Dev Mode)

# Terminal 1: Start backend
python main.py --mode server

# Terminal 2: Start Electron
cd electron
npm install
npm start

Configuration

See Configuration Reference for all environment variables.

Key Settings

Variable Default Description
VERA_LLM_OLLAMA_URL http://localhost:11434 Ollama server URL
VERA_LLM_OPENAI_API_KEY (none) OpenAI API key
VERA_LLM_GEMINI_API_KEY (none) Gemini API key
VERA_SERVER_HOST 127.0.0.1 Server bind address
VERA_SERVER_PORT 8000 Server port
VERA_SERVER_API_KEY (empty) API authentication key

Next Steps