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-coreClone the repository:
git clone https://github.com/hzrd149/applesauce.git
cd applesauceInstall dependencies:
pnpm installBuild the project:
pnpm buildThis repo uses vitest for all tests
# Run all tests
pnpm test
# Run coverage tests
pnpm coverage
# Run the tests in dev mode
pnpm vitestThis repo is setup with typedoc for the typescript documentation and vitepress for the documentation site
# Build the typedocs
pnpm typedocThe packages/docs is the package for the docs site
cd packages/docs
# Run vitepress dev
pnpm dev
# Build vitepress
pnpm buildThe applesauce-react package contains various hooks and providers for using applesauce in react components, Docs
- Fork the repository
- Create your feature branch:
git checkout -b feature/my-new-feature - Install dependencies:
pnpm install - Make your changes
- Run tests:
pnpm test - Build the project:
pnpm build - Format code:
pnpm format - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin feature/my-new-feature - Submit a pull request