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-fedimint-app #105

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Add create-fedimint-app #105

wants to merge 4 commits into from

Conversation

alexlwn123
Copy link
Member

Inspired by the create-vite script.

This pull request introduces the create-fedimint-app script, updates dependencies, and adds new templates and tests. The most important changes include the addition of the new script, updates to package dependencies, and the inclusion of new templates and tests for the create-fedimint-app package.

New Script and Templates:

  • Added create-fedimint-app script to quickly get started with the fedimint-web-sdk. (.changeset/big-lies-wonder.md, packages/create-fedimint-app/index.js, packages/create-fedimint-app/package.json) [1] [2] [3]
  • Added README for create-fedimint-app with instructions on scaffolding a Vite project. (packages/create-fedimint-app/README.md)
  • Added Vite + React + TypeScript starter template files. (packages/create-fedimint-app/template-vite-react-ts/README.md, packages/create-fedimint-app/template-vite-react-ts/_gitignore, packages/create-fedimint-app/template-vite-react-ts/index.html, packages/create-fedimint-app/template-vite-react-ts/package.json) [1] [2] [3] [4]

Dependency Updates:

  • Updated @fedimint/core-web dependency in examples/vite-core/package.json from canary to ^0.0.10. (examples/vite-core/package.json)
  • Added new dependencies and scripts to the main package.json. (package.json) [1] [2] [3]

Tests:

  • Added tests for the create-fedimint-app CLI, including prompts and scaffolding checks. (packages/create-fedimint-app/__tests__/cli.test.ts)

Build Configuration:

  • Added build configuration for the create-fedimint-app package using unbuild. (packages/create-fedimint-app/build.config.ts)

Copy link

changeset-bot bot commented Dec 11, 2024

🦋 Changeset detected

Latest commit: 2f6c018

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@fedimint/create-fedimint-app Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

socket-security bot commented Dec 11, 2024

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: npm/[email protected]

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@alexlwn123
Copy link
Member Author

@SocketSecurity ignore npm/[email protected]

Copy link
Contributor

github-actions bot commented Dec 11, 2024

Size Change: 0 B

Total Size: 7.48 MB

ℹ️ View Unchanged
Filename Size
packages/core-web/dist/index.js 2.7 kB
packages/core-web/dist/worker.js 679 B
packages/create-fedimint-app/dist/index.mjs 17.2 kB
packages/react/dist/index.js 1.29 kB
packages/wasm-bundler/fedimint_client_wasm_bg.wasm 3.73 MB
packages/wasm-web/fedimint_client_wasm_bg.wasm 3.73 MB

compressed-size-action

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.

1 participant