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 awesome projects docs page #106

Merged
merged 1 commit into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export function getSidebar() {
return [
{
base: '/core/',
collapsed: false,
text: 'Introduction',
items: [
{ text: 'Overview', link: 'overview' },
Expand All @@ -14,6 +15,7 @@ export function getSidebar() {
...FedimintWalletSidebar,
{
base: '/examples/',
collapsed: false,
text: 'Examples',
items: [
{ text: 'Vite + React', link: 'vite-react' },
Expand All @@ -26,6 +28,7 @@ export function getSidebar() {
base: '/core/dev/',
items: [
{ text: 'Contributing', link: 'contributing' },
{ text: 'Awesome Projects', link: 'awesome' },
{ text: 'Testing', link: 'testing' },
],
},
Expand All @@ -35,6 +38,7 @@ export function getSidebar() {
const FedimintWalletSidebar = [
{
text: 'Core',
collapsed: true,
link: '.',
base: '/core/FedimintWallet/',
items: [
Expand Down
4 changes: 4 additions & 0 deletions docs/core/FedimintWallet/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::

<img src="/architecture-diagram.svg" alt="Architecture" />

## Properties
Expand Down
44 changes: 44 additions & 0 deletions docs/core/dev/awesome.md
Original file line number Diff line number Diff line change
@@ -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)
Loading