Draft: refactor: make app branding customizable #1333
Conversation
|
Discussion in GitLab: In GitLab by @staceybeard on Feb 3, 2025, 15:28 EST: @AntonGladyr For this draft, could you take a look and tell me if you agree with the overall strategy? Also, if the README instructions are clear. It isn't complete, there's still a lot to be done, but I wanted some eyes on it before continuing down this path. Examples of things left to do, either in this MR or later ones: more cleanup / organization of our image folders, dealing with the Opal name on the UI, the rest of the images, etc. In GitLab by @AntonGladyr on Feb 4, 2025, 11:01 EST: Great job Stacey! I like the overall strategy :) And good job with READMEs, it was easy to follow them. In GitLab by @staceybeard on Feb 5, 2025, 10:25 EST: Thanks for reviewing :slight_smile: |
| <!-- NETWORK BANNER --> | ||
| <!-- Style the network banner to make it overlap the picture-logo --> |
There was a problem hiding this comment.
In GitLab by @staceybeard on Feb 3, 2025, 15:28 EST:
I know this strategy for getting the ids into the views is a bit redundant (could just hard-code them), but I wanted to make it clear that the ids are linked to the branding, so developers don't change them without realizing the impact.
| @@ -0,0 +1,23 @@ | |||
| // SPDX-FileCopyrightText: Copyright (C) 2025 Opal Health Informatics Group at the Research Institute of the McGill University Health Centre <john.kildea@mcgill.ca> | |||
There was a problem hiding this comment.
In GitLab by @staceybeard on Feb 4, 2025, 10:00 EST:
TODO: add copyright headers to new files
There was a problem hiding this comment.
In GitLab by @staceybeard on Feb 4, 2025, 10:38 EST:
Also update REUSE.toml (moved images).
There was a problem hiding this comment.
In GitLab by @staceybeard on Mar 25, 2025, 11:00 EDT:
Done
|
Discussion in GitLab: In GitLab by @AntonGladyr on Feb 4, 2025, 11:01 EST: Do we need to make any changes in the databases so the content is also customized accordingly? My guess there might be In GitLab by @staceybeard on Feb 5, 2025, 10:25 EST: Good point, I'll take a look |
| (function () { | ||
| 'use strict'; | ||
|
|
||
| angular |
There was a problem hiding this comment.
In GitLab by @AntonGladyr on Feb 4, 2025, 11:01 EST:
Have you considered an option of adding a style element to each branding key, so an image and styling are coupled together? It would be nice to enforce somehow that an image and css are updated/customized at the same time.
There was a problem hiding this comment.
In GitLab by @staceybeard on Feb 5, 2025, 10:25 EST:
I like the idea, I didn't think of that. I'll try it out and see how it goes.
|
In GitLab by @staceybeard on Feb 7, 2025, 11:22 EST: @Douzeyu FYI, if you want to take a look, this is what I've been doing so far with the "whitelabelling" (now "customizable branding"). The goal is to have our own Opal branding as the default, and anyone who replaces the Opal logos with their own images shouldn't have to edit too many files, it should all be easy to replace. |
staceybeard
force-pushed
the
OP-65.SB.customizable-branding
branch
from
380c407 to
8ca16d1
Compare
staceybeard
force-pushed
the
OP-65.SB.customizable-branding
branch
from
8ca16d1 to
4e772e3
Compare
In GitLab by @staceybeard on Feb 3, 2025, 14:40 EST:
By submitting this merge request, I confirm the following:
Backendproject'sREADME.md)feat: minor app version will be incremented.fix,deps,perf: patch app version will be incremented.chore,ci, etc.: app version will not be incremented.for complete set of rules.
Changes
WIP to make the app's branding customizable. The init page is currently used as an example. This MR draft is just a starting point; there are more changes to be done (e.g. the small icon and name "Opal" on the front page, the rest of the images, etc.).
resfiles.Dependencies
Acceptance Tests
Screenshots
Asset sources (edited): background, logo
Jira
See OP-65
Assignees: @staceybeard
Reviewers: @AntonGladyr
Migrated from GitLab: https://gitlab.com/opalmedapps/qplus/-/merge_requests/1333