- 📖 About the Project
- 🚀 Quick Resources
- 💻 Prerequisites
- 🛠 Libraries
- ⚙️ Development
- 🔍 Arch Map
- 🤝 Contributing
- 📝 License
Sign In With Frequency (SIWF) is the developer documentation and toolset to integrate with Frequency Access, an easy to use custodial social wallet for users on Frequency.
Looking for SIWF v1 resources? Go to the v1 branch.
- Frequency Access Home Page
- Frequency Access Swagger/Open API Docs
- Frequency Documentation
- Frequency on GitHub
- Frequency Provider Dashboard
- Sign In With Frequency UI V2 (Onboarding tool that supports both Frequency Access and other wallets)
Using Sign In With Frequency requires:
- Frequency Provider setup
- Frequency Node RPC access
These libraries can help make integrating with SIWF easier, but are not required.
The NPM package @projectlibertylabs/siwf offers both CommonJS and ESM exports.
- NPM:
npm i @projectlibertylabs/siwf - Yarn:
yarn add @projectlibertylabs/siwf
See Markdown/GitHub Docs or Live Docs.
Documentation is written in CommonMark Markdown and converted to HTML via mdBook.
- mdBook
- Cargo:
cargo install mdbook@0.4.42 - Mac Brew
brew install mdbook - Binaries: Download Release
- Cargo:
- Node.js v20+
- Build the signed-request-generator: follow the "Development" and "Build" steps in [
tools/signed-request-generator/README.md]. - Copy the new Generator to the docs directory:
rm -Rf docs/src/Generator && cp -a tools/signed-request-generator/build docs/src/Generator cd ../../docs- Serve the HTML locally and watch for changes:
mdbook serveormdbook serve -p <port, default 3000> - For style edits see:
docs/css/overrides.css - For changes to the custom preprocessor see:
docs/preprocessors/README.md
The documentation is deployed to GitHub Pages automatically on merge to main branch.
Library is published on merge to main with a development tag 0.0.0-[SHA:6].
Releases are made via GitHub Releases with tags in the style: vX.Y.Z.
Contributions, issues, and feature requests are welcome!
This project is Apache 2.0 licensed.