Weektab Webmail

nx-webmail/README.md

@@ -0,0 +1,40 @@
+# Standalone Webmail (Docker-ready)
+
+## Local setup
+
+1. Install dependencies:
+   npm install
+2. Run dev mode (Vite + API):
+   npm run dev
+3. Open:
+   http://localhost:5173
+
+## Docker (standalone)
+
+1. Copy env file:
+   cp .env.example .env
+2. Build + run:
+   docker compose up --build -d
+3. Open:
+   http://localhost:3001
+
+## Umbrel app packaging
+
+This repository is prepared for Umbrel app-store usage.
+
+1. Put this project into your app folder (folder name must match `id` in `umbrel-app.yml`, currently `nx-webmail`).
+2. Keep these files in that folder:
+   - `docker-compose.yml`
+   - `umbrel-app.yml`
+   - `Dockerfile`
+3. Add the app folder to your Umbrel community app store repo and push.
+
+Notes:
+- Umbrel uses the `app_proxy` service in `docker-compose.yml`.
+- Internal app port is `3001`.
+- If your store prefix is not `nx`, change `id` in `umbrel-app.yml` and update `APP_HOST` accordingly.
+
+## Notes
+
+- Frontend calls API on `/api/webmail/*`.
+- IMAP/SMTP credentials are provided by user login in UI.