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.

Installation

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

Development Setup

Clone the repository:

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

Install dependencies:

pnpm install
Copy

Build the project:

pnpm build
Copy

Running tests

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
Copy

Running documentation

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

# Build the typedocs
pnpm typedoc
Copy

The packages/docs is the package for the docs site

cd packages/docs

# Run vitepress dev
pnpm dev

# Build vitepress
pnpm build
Copy

React

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

Contributing

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