Prepare repository for open-source launch#28
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Original request
Prepare xpenser for open-sourcing and promotion, make the repository visually appealing, encourage contributions, and help people learn about Cleverbrush Framework. Requested defaults were MIT license, finance-app-first positioning, GitHub Discussions for community conversation, GitHub Security Advisories for vulnerability reports, and cross-promotion links to the Cleverbrush Framework GitHub repository.
What changed
README.mdinto a launch-ready project page with a finance-app-first pitch, product capabilities, Cleverbrush learning path, setup, self-hosting, API, MCP, contribution, and license sections.README.md,docs/cleverbrush-reference.md, and the public landing page:https://github.com/cleverbrush/framework.LICENSE,CONTRIBUTING.md,CODE_OF_CONDUCT.md,SECURITY.md, issue forms, and a PR template.package.jsonwhile keeping the workspace private to avoid accidental npm publication.apps/web/public/og-image.png.docs/assets/xpenser-landing-preview.png.docs/cleverbrush-reference.mdand updated landing page tests for the public copy and link labels.Reasoning
The repository already had strong implementation depth, but its public entry point was setup-heavy and missing common open-source trust and contribution signals. This change keeps the product pitch practical for users while making the Cleverbrush Framework patterns easy for developers to discover from the README, reference notes, templates, landing page, and upstream framework source repository.
The app/package workspaces remain
private: true; this PR prepares the repository for source availability and contribution, not npm package publishing.Screenshots / preview evidence
README preview asset committed in this PR:
The Open Graph image is committed at
apps/web/public/og-image.pngand was generated from the local landing page at 1200x630. Both images were refreshed after adding the Framework GitHub link.Manual preview QA on
https://xpenser-pr-028.cleverbrush.comconfirmed the product-first landing page, sign-in/register links, deployedog-image.pngat 1200x630, and the xpenser GitHub plus Framework GitHub links in the header, hero, and footer.Validation
npm run lintnpm run typechecknpm test- 58 files, 329 tests passednpm run buildwith local build secrets and Google sign-in disableddocs/assets/xpenser-landing-preview.pngapps/web/public/og-image.pngLint and testfrom the first pushDeploy PR environmentfrom the first pushPlaywright e2efrom the first pushhttps://xpenser-pr-028.cleverbrush.comfrom the first pushxpenser-web-pr-28andxpenser-api-pr-28from the first push8551f5c:Lint and test,Deploy PR environment, andPlaywright e2eall passed8551f5cconfirming the deployed Framework GitHub link8551f5cforxpenser-web-pr-28SigNoz notes:
xpenser-api-pr-28has Node.js runtime metric data (nodejs.eventloop.utilization).GitHub admin follow-up
The available GitHub connector in this environment does not expose repository settings mutation for these items. After merge, set or confirm:
https://xpenser.cleverbrush.com.personal-finance,expense-tracker,self-hosted,typescript,nextjs,cleverbrush,mcp,openapi.