Stacks Connect

Connect is a JavaScript library for building web applications connected to Stacks.

⚡️ Installation

Use your favorite package manager to install @stacks/connect in your project. Follow the Getting Started section of the @stacks/connect README.

Or use one of our starter-templates to bootstrap a fresh project already including connect — directly in your browser or using the command-line locally! e.g. via npm create stacks

📦 Packages

This repository includes three packages:

• @stacks/connect: The one-stop-shop tool for letting web-apps interact with Stacks web wallets.
• @stacks/connect-react: A wrapper library for making @stacks/connect use in React even easier
• @stacks/connect-ui: A web-component UI for displaying an intro modal in Stacks web-apps during authentication (used in the background by @stacks/connect).

🌎 More Information

The Stacks documentation website includes more examples for building apps using Connect.

It also includes guides for various aspects of Stacks application development:

• Authentication
• Transactions
• Data storage

🐛 Bugs and feature requests

If you encounter a bug or have a feature request, we encourage you to follow the steps below:

1. Search for existing issues: Before submitting a new issue, please search existing and closed issues to check if a similar problem or feature request has already been reported.
2. Open a new issue: If it hasn't been addressed, please open a new issue. Choose the appropriate issue template and provide as much detail as possible, including steps to reproduce the bug or a clear description of the requested feature.
3. Evaluation SLA: Our team reads and evaluates all the issues and pull requests. We are avaliable Monday to Friday and we make a best effort to respond within 7 business days.

Please do not use the issue tracker for personal support requests or to ask for the status of a transaction. You'll find help at the #stacks-js Discord channel.

🎁 Contribute

Development of this product happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving the product.

Code of Conduct

Please read our Code of conduct since we expect project participants to adhere to it.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

Community

Join our community and stay connected with the latest updates and discussions:

• Join our Discord community chat to engage with other users, ask questions, and participate in discussions.
• Visit hiro.so for updates and subcribing to the mailing list.
• Follow Hiro on Twitter.