brandxtech/frontend
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updating the readme steps for creating a new whitelabel

Browse source
This commit is contained in:
csawatzky 2026-04-01 16:08:11 -06:00
parent bd15f4a15f
commit 3d1c11646f
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -19,28 +19,29 @@ Steps to add a new white label
- add a login button on their website point to `/login` of their custom subdomain (ex: dashboard.example.com/login) - add a login button on their website point to `/login` of their custom subdomain (ex: dashboard.example.com/login)
<!-- frontend steps --> <!-- frontend steps -->
2. Create a PWA folder in `public` that is named after the client and generate PWA assets using [this](https://realfavicongenerator.net/) website (use the company logo but you might need to use a custom favicon depending on the result) 1. Create a PWA folder in `public` that is named after the client and generate PWA assets using [this](https://realfavicongenerator.net/) website (use the company logo but you might need to use a custom favicon depending on the result)
- https://maskable.app/ also create a maskable icon for PWA - https://maskable.app/ also create a maskable icon for PWA
- create a 512x512 png as well for PWA - create a 512x512 png as well for PWA
3. Create a white-label branding folder in `src/assets/whitelabels` and create a `darkLogo.png` and `lightLogo.png` from the client's logo 2. Create a white-label branding folder in `src/assets/whitelabels` and create a `darkLogo.png` and `lightLogo.png` from the client's logo
4. In `src/services/whiteLabel.ts`, add a new `Whitelabel` instance with the required fields and add its hostname mapping to the `whitelabels` map (it is very similar to step one but had some constraints when dealing with the `public` folder) 3. In `src/services/whiteLabel.ts`, add a new `Whitelabel` instance with the required fields and add its hostname mapping to the `whitelabels` map
5. If there are any pages specific to the whitelabel be sure to update the side and bottom navigator 4. If there are any pages specific to the whitelabel be sure to update the side and bottom navigator
<!-- backend steps --> <!-- backend steps -->
6. In `dynamic-config.prod.yml`, add a router entry for the new whitelabel 1. In `dynamic-config.prod.yml`, add a router entry for the new whitelabel
7. In `pond/http/server.go`, add the sub-domain to the `allowedOrigins` 2. In `pond/http/server.go`, add the sub-domain to the `allowedOrigins`
8. In `pond/whitelabel.go`, add an entry for the new white label 3. In `pond/whitelabel.go`, add an entry for the new white label
4. Enable the white-label sub-domain for CORS in the backend by adding it to the allowed origins http/server.go
7. Create a new `Auth0` application for the client <!-- Auth steps -->
1. Create a new `Auth0` application for the client
- use a image bucket like [postimg](https://postimages.org/) to store their company logo and favicon - use a image bucket like [postimg](https://postimages.org/) to store their company logo and favicon
- add a whitelabel logo - add a whitelabel logo
- allow necessary `origins`, `callback URLs`, and `CORS domains` to the application settings (see the default application as a guideline) - allow necessary `origins`, `callback URLs`, and `CORS domains` to the application settings (see the default application as a guideline)
- customize the Universal Login page to handle the new whitelabel - customize the Universal Login page to handle the new whitelabel
- check if the client ID matches this client's Auth0 application - check if the client ID matches this client's Auth0 application
- change the Universal Login theme using white-label colours and images stored in a bucket (ex: [postimg](https://postimages.org/)) - change the Universal Login theme using white-label colours and images stored in a bucket (ex: [postimg](https://postimages.org/))
8. Enable the white-label sub-domain for CORS in the backend
- in [http.go](https://gitlab.com/brandx/backend/blob/master/pond/http.go), add the white-label sub-domain to the `AllowedOrigins` list - in [http.go](https://gitlab.com/brandx/backend/blob/master/pond/http.go), add the white-label sub-domain to the `AllowedOrigins` list