@projectlibertylabs/siwf

Sign In With Frequency Documentation & Tools

Table of Contents

• About the Project
• Quick Resources
• Prerequisites
• Libraries
• Development
• Arch Map
• Contributing
• License

Sign In With Frequency V2

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

Prerequisites

Using Sign In With Frequency requires:

• Frequency Provider setup
• Frequency Node RPC access

(back to top)

Libraries

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

TypeScript/JavaScript

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

Install

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

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@0.4.51
  • Mac Brew brew install mdbook
  • Binaries: Download Release
• Node.js v20+

Local Development

• 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
• Install packages npm i
• Serve the HTML locally and watch for changes: mdbook serve or mdbook serve -p <port, default 3000>
• For style edits see: docs/css/overrides.css
• For changes to the custom preprocessor see: docs/preprocessors/README.md

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.

Mobile App Development

To learn more about using SIWF in your mobile app, see: docs/SDK/Overview.md

Quick Resources

• 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)

(back to top)

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)