Applesauce
    Preparing search index...

    Applesauce

    Applesauce

    Applesauce is a collection typescript libraries to make building nostr web clients easier and is used in noStrudel

    The full documentation can be found on the documentation site.

    # using npm
    npm install applesauce-core
    # using pnpm
    pnpm install applesauce-core
    # using yarn
    yarn add applesauce-core

    Clone the repository:

    git clone https://github.com/hzrd149/applesauce.git
    cd applesauce

    Install dependencies:

    pnpm install
    

    Build the project:

    pnpm build
    

    This repo uses vitest for all tests

    # Run all tests
    pnpm test
    # Run coverage tests
    pnpm coverage
    # Run the tests in dev mode
    pnpm vitest

    This repo is setup with typedoc for the typescript documentation and vitepress for the documentation site

    # Build the typedocs
    pnpm typedoc

    The apps/docs is the package for the docs site

    cd apps/docs

    # Run vitepress dev
    pnpm dev

    # Build vitepress
    pnpm build

    The applesauce-react package contains various hooks and providers for using applesauce in react components, Docs

    The applesauce-mcp tool provides semantic search over Applesauce documentation and code examples for AI agents through the Model Context Protocol. This helps AI assistants build Nostr applications with accurate API usage and real-world patterns.

    Quick Start: Connect to the public server at https://mcp.applesauce.hzrd149.com/mcp in your AI-powered IDE (OpenCode, Cursor, Claude Desktop, etc.)

    Full Documentation | Source Code

    1. Fork the repository
    2. Create your feature branch: git checkout -b feature/my-new-feature
    3. Install dependencies: pnpm install
    4. Make your changes
    5. Run tests: pnpm test
    6. Build the project: pnpm build
    7. Format code: pnpm format
    8. Commit your changes: git commit -am 'Add some feature'
    9. Push to the branch: git push origin feature/my-new-feature
    10. Submit a pull request