docs: update README, clean up old files

This commit is contained in:
lotherk
2026-03-27 13:56:47 +00:00
parent f6c4da1da3
commit 5b51de1214
7 changed files with 34 additions and 716 deletions

View File

@@ -2,8 +2,6 @@
Self-hosted AI-powered daily journaling application. Capture events throughout the day and let AI generate thoughtful diary pages from your entries.
[![Deploy to Docker](https://img.shields.io/badge/Deploy-Docker-blue)](https://github.com/lotherk/deardiary)
## Features
- Quick event capture with keyboard shortcut (Ctrl+J)
@@ -25,33 +23,47 @@ Self-hosted AI-powered daily journaling application. Capture events throughout t
```bash
# Clone the repository
git clone https://github.com/lotherk/deardiary.git
git clone git@git.kropa.tech:lotherk/deardiary.git
cd deardiary
# Configure environment (optional - defaults work out of box)
cp .env.example .env
# Start with Docker
docker compose up -d
```
Access the app at `http://localhost:5173`
Access the app at `http://localhost:3000`
Default credentials: `admin@localhost` / `changeme123`
## Documentation
Documentation is included in the `www/` directory. Run the website container:
```bash
docker compose up -d docs
```
Access at `http://localhost:4000`
## Configuration
1. Go to Settings and select your AI provider (Groq, OpenAI, Anthropic, Ollama, LM Studio)
2. Enter your API key for the selected provider
3. Optionally customize the model and base URL
4. Test the connection before saving
### Environment Variables
Copy `.env.example` to `.env` and configure:
```bash
# Backend
BACKEND_JWT_SECRET=your-secret-key
BACKEND_DEFAULT_USER_EMAIL=admin@example.com
BACKEND_DEFAULT_USER_PASSWORD=your-password
# Default AI for new users (optional)
BACKEND_DEFAULT_AI_PROVIDER=groq
BACKEND_DEFAULT_AI_MODEL=llama-3.3-70b-versatile
BACKEND_DEFAULT_AI_API_KEY=your-api-key
# Website links (for product website)
WEBSITE_APP_URL=https://your-app.example.com
GIT_URL=https://git.kropa.tech/lotherk/deardiary
```
### AI Providers
Go to Settings and select your AI provider (Groq, OpenAI, Anthropic, Ollama, LM Studio, xAI, Custom).
New users will use the system default AI settings by default. Users can uncheck "Use system default settings" to configure their own.
## Development
@@ -96,9 +108,10 @@ docker compose build && docker compose up -d
│ ├── components/
│ └── lib/ # API client, geolocation
├── www/ # Product website with docs
├── Dockerfile # App container
├── Dockerfile.docs # Website container
── docker-compose.yml
├── Dockerfile # App container (frontend + backend + nginx)
├── Dockerfile.website # Website container with envsubst
── docker-compose.yml
└── docker-entrypoint.d/ # Entrypoint scripts
```
## Routes