Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add create-rainbowkit #444

Merged
merged 12 commits into from
Jun 2, 2022

Conversation

markdalgleish
Copy link
Contributor

I'm leaving this undocumented for now so that we can trial it out first. If everything looks good once published, we can update the docs to make this more prominent.

Usage (once it's live): pnpm create @rainbow-me/rainbowkit (or yarn create or npm init)

To test locally, first compile the CLI in watch mode:

pnpm dev:cli

Then, in another terminal, run create-rainbowkit and start a dev server against the generated app:

pnpm test:cli:dev

There's more detail provided in the contribution guide.

The generated app is checked in since it's part of the monorepo and needs to be present when running pnpm install. The idea is that any changes to the template should also be reflected in updates to the generated test app.

Note: I originally tried to gitignore the generated app but found this caused issues with lock file churn since pnpm would remove it from the lock file if the app wasn't present, but this would break CI. By committing the generated app, we avoid forcing everyone to generate the test app themselves all the time, instead only generating it when the template changes and then committing the result.

@markdalgleish markdalgleish requested a review from a team as a code owner May 30, 2022 02:04
@linear
Copy link

linear bot commented May 30, 2022

@vercel
Copy link

vercel bot commented May 30, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
rainbowkit-example ✅ Ready (Inspect) Visit Preview Jun 2, 2022 at 4:42AM (UTC)
rainbowkit-site ✅ Ready (Inspect) Visit Preview Jun 2, 2022 at 4:42AM (UTC)

: []),
],
[
alchemyProvider({ alchemyId: '_gg7wSSi0KMBsdKnGVfHDueq6xMB9EkC' }),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wondering if we need to drop a comment that this is a test ID from alchemy?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants