set up the bones for the whitelabel, just need to generate the icons from a logo once we get it
This commit is contained in:
parent
3d1c11646f
commit
89a83d04dd
4 changed files with 40 additions and 7 deletions
14
README.md
14
README.md
|
|
@ -18,7 +18,10 @@ Steps to add a new white label
|
|||
- add a `CNAME` record pointing their custom subdomain (ex: dashboard.example.com) to brandxtech.ca
|
||||
- add a login button on their website point to `/login` of their custom subdomain (ex: dashboard.example.com/login)
|
||||
|
||||
It is recommended to start with the Auth0 stage once everything from the client has been recieved as things like the client ID will be needed in other stages
|
||||
|
||||
<!-- frontend steps -->
|
||||
Frontend Steps
|
||||
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
|
||||
|
|
@ -29,22 +32,23 @@ Steps to add a new white label
|
|||
4. If there are any pages specific to the whitelabel be sure to update the side and bottom navigator
|
||||
|
||||
<!-- backend steps -->
|
||||
Backend Steps
|
||||
1. In `dynamic-config.prod.yml`, add a router entry for the new whitelabel
|
||||
2. In `pond/http/server.go`, add the sub-domain to the `allowedOrigins`
|
||||
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
|
||||
|
||||
<!-- Auth steps -->
|
||||
1. Create a new `Auth0` application for the client
|
||||
Auth0 Steps
|
||||
1. Create a new Single Page App on Auth0 using React as the tech
|
||||
2. Once you have the client ID add it to your .env file in the frontend
|
||||
3. Adjust settings accordingly in the new application
|
||||
- use a image bucket like [postimg](https://postimages.org/) to store their company logo and favicon
|
||||
- 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 other applications/whitelabels as a guideline)
|
||||
- customize the Universal Login page to handle the new whitelabel
|
||||
- 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/))
|
||||
|
||||
- in [http.go](https://gitlab.com/brandx/backend/blob/master/pond/http.go), add the white-label sub-domain to the `AllowedOrigins` list
|
||||
|
||||
## Expanding the ESLint configuration
|
||||
|
||||
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue