From f708191edef2561f64dc1c5a8979a43161efcac4 Mon Sep 17 00:00:00 2001 From: Manuel Bustillo Date: Sun, 1 Dec 2024 18:21:33 +0100 Subject: [PATCH] Indicate in the README that the application is multi-tenant --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e8d48e..e1cc204 100644 --- a/README.md +++ b/README.md @@ -57,8 +57,13 @@ The backend service will seed the database with fake data. It's worth noting tha The backend, frontend and workers have hot-reloading enabled, so changes made to the codebase should be reflected in the application on the next request. -Once all containers have started, visit http://libre-wedding-planner.app.localhost/dashboard to load the application. +Once all containers have started, visit http://libre-wedding-planner.app.localhost/default/dashboard to load the application. +## Multitenancy + +LibreWeddingPlanner is designed to manage multiple weddings in a single host. All URLs (in the API and the frontend) are scoped under a slug that is unique per wedding. The slug is made of lowercase letters, numbers, and dashes (-). + +The development environment is seeded with a wedding whose slug is `default`. ## Email delivery In the development environment, real emails will not be sent. You can visit http://libre-wedding-planner.app.localhost/letter_opener/ to get a list of emails generated by the application.