Skip to content

Commit

Permalink
docs: theming
Browse files Browse the repository at this point in the history
  • Loading branch information
blt950 committed Oct 2, 2023
1 parent f481e7f commit 597d645
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
28 changes: 18 additions & 10 deletions CONFIGURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,19 +76,27 @@ To change the logo to yours, bind your logo image files to `public/images/logos`
| APP_LOGO | vatsca.svg | The logo of your subdivision, located in `public/images/logos` |
| APP_LOGO_MAIL | vatsca-email.png | The logo of your subdivision, located in `public/images/logos` |

To change the colors of your Control Center, change the following variables and run `npm run build` in the container to rebuild.
To change the bootstrap colors to match your division, first change the environment variables and then run the following command

| Variable | Default value | Explanation |
| ------- | --- | --- |
| BOOTSTRAP_COLOR_PRIMARY | #1a475f | Primary color of your theme |
| BOOTSTRAP_COLOR_SECONDARY | #484b4c | Secondary color of your theme |
| BOOTSTRAP_COLOR_TERTIARY | #011328 | Tertiary color of your theme |
| BOOTSTRAP_COLOR_INFO | #17a2b8 | Info color of your theme |
| BOOTSTRAP_COLOR_SUCCESS | #41826e | Success color of your theme |
| BOOTSTRAP_COLOR_WARNING | #ff9800 | Warning color of your theme |
| BOOTSTRAP_COLOR_DANGER | #b63f3f | Danger color of your theme |
| BOOTSTRAP_BORDER_RADIUS | 2px | Border radius of your theme |

| VITE_THEME_PRIMARY | #1a475f | Primary color of your theme |
| VITE_THEME_SECONDARY | #484b4c | Secondary color of your theme |
| VITE_THEME_TERTIARY | #011328 | Tertiary color of your theme |
| VITE_THEME_INFO | #17a2b8 | Info color of your theme |
| VITE_THEME_SUCCESS | #41826e | Success color of your theme |
| VITE_THEME_WARNING | #ff9800 | Warning color of your theme |
| VITE_THEME_DANGER | #b63f3f | Danger color of your theme |
| VITE_THEME_BORDER_RADIUS | 2px | Border radius of your theme |

Run this command to build the theme. If you get an error like `"#5f271a" is not a color`, remove the `"` quotes from your environment variable.
```sh
docker exec -it control-center sh container/theme/build.sh
```

> **Note**
> 1. Building custom themes will increase your container size with ~200mb when completed. When you run this command, we need install dependencies inside your container to build the theme and then remove them again. This is done to keep the container size down.
> 2. You need to run this command each time you recreate the container.
### Optional: Extras

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ To setup your Docker instance simply follow these steps:

## Updating

Updating only requires you to run migration and clear caches.
Updating only requires you to run migration and clear caches. Remember also running the theming command again if you have a custom theme.

```sh
docker exec -it --user www-data control-center php artisan migrate
Expand Down

0 comments on commit 597d645

Please sign in to comment.