https://github.com/fedimint/fedimint-web-sdk
Tools for developing Fedimint web clients
https://github.com/fedimint/fedimint-web-sdk
bitcoin ecash fedimint library react typescript web
Last synced: 8 months ago
JSON representation
Tools for developing Fedimint web clients
- Host: GitHub
- URL: https://github.com/fedimint/fedimint-web-sdk
- Owner: fedimint
- License: mit
- Created: 2024-09-04T18:07:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T18:07:28.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:44:48.729Z (over 1 year ago)
- Topics: bitcoin, ecash, fedimint, library, react, typescript, web
- Language: JavaScript
- Homepage: https://web.fedimint.org
- Size: 20.8 MB
- Stars: 19
- Watchers: 1
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: .github/README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Fedimint Web SDK
A Robust, privacy-focused, and WebAssembly-powered fedimint client for the browser.
Docs Site: web.fedimint.org
## Packages 📦
| Package | Version | Description |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| [`@fedimint/core`](https://npmjs.com/package/fedimint/core) | ![NPM Version (latest)]() | Typescript interface for the Fedimint client wasm |
| [`@fedimint/react`](https://web.fedimint.org/docs/core/getting-started) | ![NPM Version (latest)]() | React components and hooks for interacting with the Fedimint client |
| [`@fedimint/wasm-web`](../packages/wasm-web/README.md) | ![NPM Version (latest)]() | Not intended for direct use. Contains the wasm pack output (target web) for the Fedimint client wasm. |
| [`@fedimint/wasm-bundler`](../packages/wasm-bundler/README.md) | ![NPM Version (latest)]() | Not intended for direct use. Contains the wasm pack output (target bundler) for the Fedimint client wasm. |
| [`create-fedimint-app`](../packages/create-fedimint-app/README.md) | ![NPM Version (latest)]() | Scaffold a new Fedimint app with Vite, React, and TypeScript. |
## Structure 🛠️
This monorepo is structured as a pnpm workspace. There are some helpful scripts in the root `package.json` to help manage the workspace.
```bash
fedimint-web-sdk
├── README.md
├── examples
│ ├── vite-core
│ ├── next-js
│ ├── webpack-app
│ └── bare-js
└── packages
├── core
├── react
├── wasm-web
├── wasm-bundler
└── create-fedimint-app
```
### Examples
- [`vite-core`](../examples/vite-core/README.md): Simple example of how to use the `core` package within a React app bundled with Vite.
- [`bare-js`](../examples/bare-js/README.md): Simple example of how to use the `core` package in a bare javascript environment (no bundler)
- [`next-js`](../examples/next-js/README.md): Example configuration for use within a `nextjs` project.
- [`webpack-app`](../examples/webpack-app/README.md): Example configuration for use within a project bundled with `webpack`.
### Credit
Used the [wagmi](https://github.com/wevm/wagmi) library as a reference for the repo's structure.