Sign In With Access Documentation & Tools

📗 Table of Contents

• 📖 About the Project
• 🚀 Quick Resources
• 💻 Prerequisites
• 🛠 Libraries
• ⚙️ Development
• 🔍 Arch Map
• 🤝 Contributing
• 📝 License

📖 Sign In With Access

Sign In With Access (SIWA) is the developer documentation and toolset to integrate with Frequency Access, an easy to use custodial social wallet for users on Frequency.

🚀 Quick Resources

• Frequency Access Home Page
• Frequency Access Swagger/Open API Docs
• Frequency Documentation
• Frequency on GitHub
• Frequency Provider Dashboard
• Sign In With Frequency (Onboarding tool that supports both Frequency Access and other wallets)

(back to top)

💻 Prerequisites

Using Sign In With Access requires:

• Frequency Provider setup
• Frequency Node RPC access

(back to top)

🛠 Libraries

These libraries can help make integrating with SIWA easier, but are not required.

TypeScript/JavaScript

The NPM package @projectlibertylabs/siwa offers both CommonJS and ESM exports.

Install

• NPM: npm i @projectlibertylabs/siwa
• Yarn: yarn add @projectlibertylabs/siwa

Documentation

See Markdown/GitHub Docs or Live Docs.

(back to top)

⚙️ Development

Documentation

Documentation is written in CommonMark Markdown and converted to HTML via mdBook.

Prerequisites

• mdBook
  • Cargo: cargo install mdbook
  • Mac Brew brew install mdbook
  • Binaries: Download Release
• Node.js v20+

Local Development

• Serve the HTML locally and watch for changes: mdbook serve or mdbook serve -p <port, default 3000>
• For style edits see: docs/css/extended.css
• For changes to the custom preprocessor see: docs/preprocessor.mjs

Deployment

The documentation is deployed to GitHub Pages automatically on merge to main branch.

Library: TypeScript/JavaScript

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.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

• Contributing Guidelines
• Open Issues

(back to top)

📝 License

This project is Apache 2.0 licensed.

(back to top)