Initial commit with development environment instructions

This commit is contained in:
Joakim Svensson
2025-12-29 21:34:17 +00:00
commit a1e85e7db5
7 changed files with 631 additions and 0 deletions

76
README.md Normal file
View File

@@ -0,0 +1,76 @@
# HedgeAgent
En intelligent agent som övervakar och interagerar med HedgeDoc-dokument i realtid.
## Funktioner
- **Live-chatt:** Skriv prompts direkt i dokumentet inom `<!--Agent -->`-block.
- **Tänker-indikator:** Visar animerad feedback när agenten genererar svar.
- **Webbgränssnitt:** Enkelt gränssnitt på port 5000 för att lägga till nya dokument.
- **Robust inloggning:** Automatisk återanslutning vid utgångna sessioner.
## Snabbstart med Docker
### Alternativ 1: Docker Compose (Rekommenderas)
1. **Skapa en `.env`-fil:**
```env
HEDGEDOC_EMAIL=din@epost.se
HEDGEDOC_PASSWORD=ditt lösenord
HEDGEDOC_BASE_URL=https://hedgedoc.din-doman.se
LLM_API_KEY=sk-or-v1-...
```
2. **Kör med compose:**
```bash
docker compose up -d
```
### Alternativ 2: Docker CLI
```bash
docker build -t hedgeagent .
docker run -d \
--name hedgeagent \
-p 5000:5000 \
--env-file .env \
-v $(pwd)/active_notes.txt:/app/active_notes.txt \
hedgeagent
```
## Utvecklingsmiljö
För att köra HedgeAgent lokalt utan Docker:
1. **Förutsättningar:**
- Python 3.10+ installerat.
2. **Skapa och aktivera en virtuell miljö:**
```bash
python -m venv venv
source venv/bin/activate # På Windows: venv\Scripts\activate
```
3. **Installera beroenden:**
```bash
pip install -r requirements.txt
playwright install chromium
```
4. **Konfigurera miljövariabler:**
Skapa en `.env`-fil (se exemplet ovan) eller sätt dem i din shell.
5. **Starta applikationen:**
```bash
python hedgeagent.py
```
## Användning
1. Öppna webbgränssnittet på `http://localhost:5000`.
2. Klistra in URL:en till ett HedgeDoc-dokument.
3. I dokumentet, skriv din fråga efter `-> ` i ett Agent-block:
```markdown
<!--Agent
User: Hej!
Agent: Hej, vad kan jag hjälpa dig med?
-> [Skriv här och tryck Enter]
-->
```