bustikiller/wedding-planner
1
0
Fork 0
Code Issues Pull Requests 4 Actions Packages Projects Releases Wiki Activity

Merge pull request 'Indicate in the README that the application is multi-tenant' (#156) from wedding-creation into main
Some checks failed
Check usage of free licenses / check-licenses (push) Successful in 1m8s
Details
Run unit tests / unit_tests (push) Successful in 3m12s
Details
Build Nginx-based docker image / build-static-assets (push) Failing after 17m14s
Details

Browse Source 
Reviewed-on: #156
This commit is contained in:
bustikiller 2024-12-01 17:26:24 +00:00
commit 241668b84d
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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.