diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 5626cf2..2a39e24 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -52,6 +52,10 @@ export default defineConfig({ text: 'Contributing', link: '/core/dev/contributing', }, + { + text: 'Awesome Fedimint Web SDK', + link: '/core/dev/awesome', + }, { text: 'Discussions ', link: 'https://chat.fedimint.org', diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts index 1bb9cf0..510631d 100644 --- a/docs/.vitepress/sidebar.ts +++ b/docs/.vitepress/sidebar.ts @@ -4,6 +4,7 @@ export function getSidebar() { return [ { base: '/core/', + collapsed: false, text: 'Introduction', items: [ { text: 'Overview', link: 'overview' }, @@ -14,6 +15,7 @@ export function getSidebar() { ...FedimintWalletSidebar, { base: '/examples/', + collapsed: false, text: 'Examples', items: [ { text: 'Vite + React', link: 'vite-react' }, @@ -26,6 +28,7 @@ export function getSidebar() { base: '/core/dev/', items: [ { text: 'Contributing', link: 'contributing' }, + { text: 'Awesome Projects', link: 'awesome' }, { text: 'Testing', link: 'testing' }, ], }, @@ -35,6 +38,7 @@ export function getSidebar() { const FedimintWalletSidebar = [ { text: 'Core', + collapsed: true, link: '.', base: '/core/FedimintWallet/', items: [ diff --git a/docs/core/FedimintWallet/index.md b/docs/core/FedimintWallet/index.md index 8630908..7bb8c5c 100644 --- a/docs/core/FedimintWallet/index.md +++ b/docs/core/FedimintWallet/index.md @@ -2,6 +2,10 @@ The `FedimintWallet` class serves as the main entry point for the library. It orchestrates the various services and the WorkerClient. +::: info +Check out the [Getting Started](../getting-started) guide to get started using the Fedimint Web SDK. +::: + Architecture ## Properties diff --git a/docs/core/dev/awesome.md b/docs/core/dev/awesome.md new file mode 100644 index 0000000..7ed8378 --- /dev/null +++ b/docs/core/dev/awesome.md @@ -0,0 +1,44 @@ +# Awesome Projects + +A curated list of awesome projects, resources, and tools built with the **Fedimint Web SDK**. + +## Applications + +### Community Apps + +- [Browsimint](https://github.com/IroncladDev/browsimint) - Browser extension lighting/ecash wallet. Beautiful UI. Supports joining multiple federations. +- [ATL Bitlab Wallet](https://ecashdemo.atlbitlab.com/) - Wallet for the Atlanta Bitcoin Community. +- [Bitsacco](https://bitsacco.com/) - Currently built using fedimint-clientd. Transitioning to use the Fedimint Web SDK. + +### Demo Apps + +- [Vite Core Example](https://github.com/fedimint/fedimint-web-sdk/tree/main/examples/vite-core) - Basic example using @fedimint/core-web +- [Bare JS Example](https://github.com/fedimint/fedimint-web-sdk/tree/main/examples/bare-js) - Minimal JavaScript implementation + +## Templates + +- [Create Fedimint App](https://github.com/fedimint/fedimint-web-sdk/tree/main/packages/create-fedimint-app) - Official project scaffolding tool + - Vite + React + - Vite + React + TypeScript + - Vite + React + TypeScript + Hooks + +## Tools & Libraries + +- [@fedimint/core-web](https://github.com/fedimint/fedimint-web-sdk/tree/main/packages/core-web) - Core Fedimint web utilities +- [@fedimint/react](https://github.com/fedimint/fedimint-web-sdk/tree/main/packages/react) - React contexts and hooks + +## Contributing + +Want to add your project to this list? Please submit a PR! + +### Guidelines + +- Ensure your project uses the Fedimint Web SDK +- Include a brief description +- Follow the existing format +- Add your project to the appropriate category + +## Resources + +- [Official Documentation](https://web.fedimint.org) +- [GitHub Repository](https://github.com/fedimint/fedimint-web-sdk)