As noted in https://github.com/quantum-wealth/docs/issues/46 we want to Open Source as much non "secret sauce" code/components as possible to invite contribution from the coding community.
Sealed Secrets are a great candidate for Open Source because they are generally useful to most teams/projects/companies and not at all specific to us.
With this in mind, we need to review the README.md of this project and tidy+enhance it for public consumption to answer as many common "onboarding" questions as possible and streamline the process of running/deploying the UI.
As noted in https://github.com/quantum-wealth/docs/issues/46 we want to Open Source as much non "secret sauce" code/components as possible to invite contribution from the coding community. Sealed Secrets are a great candidate for Open Source because they are generally useful to most teams/projects/companies and not at all specific to us. With this in mind, we need to review the
README.md
of this project and tidy+enhance it forpublic
consumption to answer as many common "onboarding" questions as possible and streamline the process of running/deploying the UI.Todo
README.md
with a beginner's mind 🔰localhost
as fill-in any gaps in the setup instructions - this is the baseline for contribution.Bonus Level
GitHub CI
to test the code.tests
to gain confidence that nothing will break when people contribute.code
(not much)