-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c65fa2a
commit c42beec
Showing
2 changed files
with
89 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,100 @@ | ||
| # <img src="docs/radix-logo.png" alt="Radix Logo" width="35" height="35"> Radix dApp Toolkit: Tools for building dApps on Radix | ||
| <div align="center"> | ||
| <img src="docs/radix-logo.png" alt="Radix Logo" width="100"> | ||
|
|
||
| [](https://badge.fury.io/js/@radixdlt%2Fradix-dapp-toolkit) | ||
| # Radix dApp Toolkit | ||
|
|
||
| # Radix dApp Toolkit - v2 Monorepo | ||
| <em> RDT is a TypeScript library that simplifies interactions between your dApp and Radix Wallet. It comes together with a custom HTML element which provides unified interface to display user information.</em> | ||
|
|
||
| Look for dApp toolkit and related packages under the [/packages](/packages/) directory. Example applications are under the [/examples](/examples/) directory. | ||
| <a href="https://radixdlt.com/"><strong>radixdlt.com</strong></a> | ||
|
|
||
| </div> | ||
| <p align="center"> | ||
| <a href="https://docs.radixdlt.com/docs">Radix Docs</a> | ||
| · | ||
| <a href="CONTRIBUTION.md">Contributing Guidelines</a> | ||
| · | ||
| <a href="https://github.com/radixdlt/radix-dapp-toolkit/issues">Submit an Issue</a> | ||
| </p> | ||
|
|
||
| [Apache 2.0 License](LICENSE) | ||
| <p align="center"> | ||
| <a href="LICENSE"> | ||
| <img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="license" /> | ||
| </a> | ||
| <a href="RADIX-SOFTWARE-EULA"> | ||
| <img src="https://img.shields.io/badge/EULA-red" alt="eula" /> | ||
| </a> | ||
| <br/> | ||
| <a href="https://www.npmjs.com/@radixdlt/radix-dapp-toolkit"> | ||
| <img src="https://img.shields.io/npm/v/@radixdlt/radix-dapp-toolkit.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen" alt="RDT on NPM" /> | ||
| </a> | ||
| <a href="http://discord.gg/radixdlt"> | ||
| <img src="https://img.shields.io/discord/417762285172555786.svg?logo=discord&logoColor=fff&label=Discord&color=7389d8" alt="Discord conversation" /> | ||
| </a> | ||
| <a href="https://www.npmjs.com/@radixdlt/radix-dapp-toolkit"> | ||
| <img src="https://img.shields.io/npm/dm/@radixdlt/radix-dapp-toolkit" alt="Discord conversation" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| - [Code of Conduct](CODE_OF_CONDUCT.md) | ||
| - [Contribution Guidelines](CONTRIBUTION.md) | ||
| - [EULA](RADIX-SOFTWARE-EULA) | ||
| <hr> | ||
|
|
||
| This is merging [Radix dApp Toolkit](https://github.com/radixdlt/radix-dapp-toolkit), [√ Connect Button](https://github.com/radixdlt/connect-button), [Wallet Request SDK](https://github.com/radixdlt/wallet-sdk), [Radix Connect Schemas](https://github.com/radixdlt/radix-connect-schemas) into one mono-repository. | ||
| ## How to start? | ||
|
|
||
| ## Migration guide | ||
| Install [Node.js] which includes [Node Package Manager][npm]. Use `create-radix-dapp` package - paste following command into your terminal and it will walk you through all required steps! | ||
|
|
||
| - [v1 -> v2 migration guide](docs/v2.md) | ||
| ```bash | ||
| npx create-radix-dapp@latest | ||
| ``` | ||
|
|
||
| ## Versions In This Repository | ||
| > [!IMPORTANT] | ||
| > **Make sure you go through [README inside RDT package](packages/dapp-toolkit/README.md) for more in-depth information** | ||
| - [main](https://github.com/radixdlt/radix-dapp-toolkit/commits/main) - This is all of the current work, which is against v2 of RDT right now | ||
| ### Official Examples | ||
|
|
||
| Most PRs should be made to **main**. | ||
| Make sure you take a look at our [official examples repository](https://github.com/radixdlt/official-examples/tree/main/getting-started). It will provide you with examples of not only how to start with RDT but also how to **issue your first cryptocurrency**! | ||
|
|
||
| ## Important | ||
| ## Structure | ||
|
|
||
| By contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity. | ||
| Look for dApp toolkit and related packages under the [/packages](/packages/) directory. Example applications are under the [/examples](/examples/) directory. | ||
|
|
||
| ## Development | ||
|
|
||
| 1. `cd` to the repository root | ||
| 2. `npm install` to install all dependencies | ||
| 3. `npm run test` will run the test suite | ||
| 4. `npm run dev` will start the dApp toolkit development servers | ||
|
|
||
| ## Changelog | ||
|
|
||
| Learn about the latest improvements by looking at [GitHub Releases](https://github.com/radixdlt/radix-dapp-toolkit/releases) page | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Contributing Guidelines | ||
|
|
||
| Read through our [contributing guidelines](CONTRIBUTION.md) to learn about our submission process, coding rules, and more. | ||
|
|
||
| ### Want to Help? | ||
|
|
||
| Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for [contributing](CONTRIBUTION.md) and start building together with the community! | ||
|
|
||
| ### Code of Conduct | ||
|
|
||
| Help us keep Radix dApp Toolkit open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Community | ||
|
|
||
| Join the conversation and help the community. | ||
|
|
||
| - [X][X] | ||
| - [Discord][discord] | ||
| - [YouTube][youtube] | ||
| - [GitHub](https://github.com/radixdlt) | ||
| - [Blog](https://www.radixdlt.com/blog) | ||
|
|
||
| **Love Radix dApp Toolkit? Give our repo a star :star: :arrow_up:.** | ||
|
|
||
| [node.js]: https://nodejs.org/ | ||
| [npm]: https://www.npmjs.com/get-npm | ||
| [X]: https://x.com/RadixDLT | ||
| [discord]: http://discord.gg/radixdlt | ||
| [youtube]: https://www.youtube.com/c/radixdlt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters