Initial commit: Callsign Generator with FastAPI and React
This commit is contained in:
64
README.md
Normal file
64
README.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Callsign Generator
|
||||
|
||||
En webbaserad tjänst för att generera realistiska CB-handles (callsigns) med hjälp av AI. Tjänsten använder en "dialogisk" approach där användaren kan förfina resultatet genom adaptiva följdfrågor innan det slutgiltiga callsignet genereras.
|
||||
|
||||
## Funktioner
|
||||
|
||||
- **Initial Input:** Välj stil (Militär, Humor, Klassisk), ton och ge en kort beskrivning.
|
||||
- **Adaptiva Följdfrågor:** Möjlighet att låta AI:n ställa 1-3 relevanta frågor för att bättre förstå vem användaren är.
|
||||
- **Smart Generering:** Skapar ett realistiskt callsign med en tillhörande motivering.
|
||||
- **Modernt UI:** Byggt med React och Tailwind CSS.
|
||||
- **Backend:** FastAPI (Python) som kommunicerar med OpenRouter (Gemini-2.0-Flash).
|
||||
|
||||
## Arkitektur
|
||||
|
||||
Projektet är uppdelat i två delar:
|
||||
- `/frontend`: React-applikation byggd med Vite.
|
||||
- `/backend`: FastAPI-server.
|
||||
|
||||
Hela stacken är containeriserad med Docker.
|
||||
|
||||
## Kom igång
|
||||
|
||||
### Förutsättningar
|
||||
|
||||
- Docker och Docker Compose installerat.
|
||||
- En API-nyckel från [OpenRouter](https://openrouter.ai/).
|
||||
|
||||
### Installation
|
||||
|
||||
1. Klona repot:
|
||||
```bash
|
||||
git clone ssh://git@git.sa6anw.se:2222/sa6anw/HandleAgent.git
|
||||
cd HandleAgent
|
||||
```
|
||||
|
||||
2. Skapa en `.env`-fil i rotmappen:
|
||||
```env
|
||||
OPENROUTER_API_KEY=din_api_nyckel_här
|
||||
```
|
||||
|
||||
3. Starta med Docker Compose:
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
4. Öppna webbläsaren på `http://localhost:5173`.
|
||||
|
||||
## Utveckling
|
||||
|
||||
Om du vill köra komponenterna separat:
|
||||
|
||||
### Backend
|
||||
```bash
|
||||
cd backend
|
||||
pip install -r requirements.txt
|
||||
uvicorn main:app --reload
|
||||
```
|
||||
|
||||
### Frontend
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
Reference in New Issue
Block a user