docs: Add environment variables configuration to README
This commit is contained in:
39
README.md
Normal file
39
README.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# claudia-docs-web
|
||||||
|
|
||||||
|
Claudia Docs Frontend — Vue 3 + Pinia + Vite
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
|
||||||
|
| Variable | Default | Description |
|
||||||
|
|----------|---------|-------------|
|
||||||
|
| `VITE_API_BASE_URL` | `http://localhost:8000/api/v1` | Backend API URL |
|
||||||
|
|
||||||
|
### Example Docker Compose
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
environment:
|
||||||
|
- VITE_API_BASE_URL=http://localhost:8000/api/v1
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Rich text editing with TipTap
|
||||||
|
- Document reasoning and metadata
|
||||||
|
- Graph view of document relationships
|
||||||
|
- Backlinks between documents
|
||||||
|
- Quick switcher (Cmd+K)
|
||||||
|
- Dark mode
|
||||||
|
- Export to Markdown/JSON
|
||||||
Reference in New Issue
Block a user