Rewrite README file
This commit is contained in:
6
.gitignore
vendored
6
.gitignore
vendored
@ -108,4 +108,8 @@ playwright-report/
|
||||
playwright/.cache/
|
||||
|
||||
# TypeScript
|
||||
*.tsbuildinfo
|
||||
*.tsbuildinfo
|
||||
|
||||
# CLAUDE artifacts
|
||||
CLAUDE.md
|
||||
.claude/
|
||||
44
README.md
44
README.md
@ -1 +1,43 @@
|
||||
# Palace
|
||||
# Palace - Bubo's Memory Palace
|
||||
|
||||
## Deployment
|
||||
|
||||
### Option 1: IndexedDB Only (No Backend)
|
||||
|
||||
```bash
|
||||
# Build and run frontend only
|
||||
docker-compose -f docker-compose.indexeddb.yml up -d
|
||||
```
|
||||
|
||||
### Option 2: Full Stack with Backend
|
||||
|
||||
```bash
|
||||
# Build and run frontend + backend
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### Production Deployment
|
||||
|
||||
For palace.raphaelforment.fr:
|
||||
|
||||
1. **IndexedDB version:**
|
||||
```bash
|
||||
docker build -f Dockerfile.frontend -t palace-frontend .
|
||||
docker run -p 80:80 palace-frontend
|
||||
```
|
||||
|
||||
2. **Full stack version:**
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
The frontend automatically detects the production domain and connects to the backend API at port 3001.
|
||||
|
||||
### Ports
|
||||
|
||||
- Frontend: 80
|
||||
- Backend API: 3001
|
||||
|
||||
### Data Persistence
|
||||
|
||||
The backend uses SQLite with a persistent volume mounted at `/data/palace.db`.
|
||||
|
||||
41
deploy.md
41
deploy.md
@ -1,41 +0,0 @@
|
||||
# Palace Deployment Guide
|
||||
|
||||
## Option 1: IndexedDB Only (No Backend)
|
||||
|
||||
```bash
|
||||
# Build and run frontend only
|
||||
docker-compose -f docker-compose.indexeddb.yml up -d
|
||||
```
|
||||
|
||||
## Option 2: Full Stack with Backend
|
||||
|
||||
```bash
|
||||
# Build and run frontend + backend
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Production Deployment
|
||||
|
||||
For palace.raphaelforment.fr:
|
||||
|
||||
1. **IndexedDB version:**
|
||||
```bash
|
||||
docker build -f Dockerfile.frontend -t palace-frontend .
|
||||
docker run -p 80:80 palace-frontend
|
||||
```
|
||||
|
||||
2. **Full stack version:**
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
The frontend automatically detects the production domain and connects to the backend API at port 3001.
|
||||
|
||||
## Ports
|
||||
|
||||
- Frontend: 80
|
||||
- Backend API: 3001
|
||||
|
||||
## Data Persistence
|
||||
|
||||
The backend uses SQLite with a persistent volume mounted at `/data/palace.db`.
|
||||
Reference in New Issue
Block a user