From 9d800530936e968582141135c30afabb3350843d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Forment?= Date: Sat, 19 Jul 2025 11:39:57 +0200 Subject: [PATCH] Rewrite README file --- .gitignore | 6 +++++- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- deploy.md | 41 ----------------------------------------- 3 files changed, 48 insertions(+), 43 deletions(-) delete mode 100644 deploy.md diff --git a/.gitignore b/.gitignore index fa781c8..9da2e3f 100644 --- a/.gitignore +++ b/.gitignore @@ -108,4 +108,8 @@ playwright-report/ playwright/.cache/ # TypeScript -*.tsbuildinfo \ No newline at end of file +*.tsbuildinfo + +# CLAUDE artifacts +CLAUDE.md +.claude/ \ No newline at end of file diff --git a/README.md b/README.md index 012c09e..5962891 100644 --- a/README.md +++ b/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`. diff --git a/deploy.md b/deploy.md deleted file mode 100644 index e9d890d..0000000 --- a/deploy.md +++ /dev/null @@ -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`. \ No newline at end of file