feat: add README.md
This commit is contained in:
parent
a35f4530b4
commit
13d054fcc9
42
README.md
42
README.md
@ -1,3 +1,41 @@
|
|||||||
# template-studio
|
# Template Studio
|
||||||
|
|
||||||
Mobile-first email template and report builder for Arrowstack applications.
|
Mobile-first email template and report builder for Arrowstack applications.
|
||||||
|
|
||||||
|
## Current MVP
|
||||||
|
|
||||||
|
- PWA designed from 320px upward
|
||||||
|
- tap-to-add and tap-to-edit block workflow
|
||||||
|
- local IndexedDB draft persistence plus debounced server autosave
|
||||||
|
- report and email template profiles
|
||||||
|
- sample JSON data and variable bindings
|
||||||
|
- MJML email rendering
|
||||||
|
- HTML and A4 PDF report rendering
|
||||||
|
- immutable publish versions
|
||||||
|
- server-side Keycloak OIDC authorization-code + PKCE flow
|
||||||
|
- PostgreSQL persistence
|
||||||
|
|
||||||
|
## Local development
|
||||||
|
|
||||||
|
Copy `.env.example` to `.env`, provide a PostgreSQL database, and leave `AUTH_REQUIRED=false` for local-only development.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
The production deployment uses Arrowstack MCP to inject `DATABASE_URL`, `KEYCLOAK_ISSUER`, `KEYCLOAK_CLIENT_ID`, and `KEYCLOAK_CLIENT_SECRET`. Never commit real credentials.
|
||||||
|
|
||||||
|
## Production
|
||||||
|
|
||||||
|
Canonical public repository:
|
||||||
|
|
||||||
|
```text
|
||||||
|
https://git.arrowstack.dev/Admin/template-studio
|
||||||
|
```
|
||||||
|
|
||||||
|
Production URL:
|
||||||
|
|
||||||
|
```text
|
||||||
|
https://templates.arrowstack.dev
|
||||||
|
```
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user