https://github.com/nightowlcasino/dApp-connector-react-package
React package that is an Ergo dApp Connector. Current supported wallets are Nautilus Wallet and SafeW.
https://github.com/nightowlcasino/dApp-connector-react-package
Last synced: 5 days ago
JSON representation
React package that is an Ergo dApp Connector. Current supported wallets are Nautilus Wallet and SafeW.
- Host: GitHub
- URL: https://github.com/nightowlcasino/dApp-connector-react-package
- Owner: nightowlcasino
- License: mit
- Created: 2022-05-14T02:08:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-07T15:43:33.000Z (over 1 year ago)
- Last Synced: 2025-04-20T14:59:01.964Z (16 days ago)
- Language: JavaScript
- Homepage:
- Size: 3.24 MB
- Stars: 7
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ergo - dApp Connector React Package (NightOwl) - 12 dApp Connector. [`JS/TS`, `React`] *(Community)* (📚 SDKs & Libraries <a id="sdks--libraries"></a> / 🤝 Community SDKs/Libraries <a id="community-sdkslibraries"></a>)
README
[![MIT License][license-shield]][license-url]
Ergo dApp Connector React Package
Table of Contents
*If you want to go directly to the installation and usage click [here](#installation)*
## About The Project
Many Open-Source dApps on top of Ergo have already developed their dApp connector. Every dApp has done it similarly but with some minor differences. New developers coming into Ergo will be able to avoid spending days developing and testing something that has already been done, giving them more time to focus on their specific project.
This component contains the Ergo dApp Connector and can help new developers by adding the dApp Connector in a few clicks.
No dApp has implemented clearing wallet functionality to this date(30/05/2022), we believe this is a huge step in the Ergo ecosystem that improves user experience.
This idea came from an Ergo Community member suggesting creating more documentation regarding Ergo dApp Connection. He was having trouble with the dApp connector, and looking at the open-Source code was not enough. His suggestion made the Night Owl team believe that creating an Ergo dApp Connector during the ErgoHack would potentially be the most helpful tool for future developers coming to build on Ergo. We're hoping our open-source code helps other projects too!
Open-source is the way!
##### 1. What is this package/library?
Ergo dApp Connector library for React came out of the necessity of various users while developing websites for their dApps. The package contains a component that is an Ergo dApp Connector, which means that by downloading it and calling it in your code, you will have handled the whole dApp Connection! Examples of how to do this will be demonstrated.
##### 2. Who does it benefit?
It benefits new developers coming to build on Ergo who want to avoid dealing with the dApp Connection. Even if the developer didn’t want to use the package itself, he could access this package's public and open-source repository, understand how it is done line by line, and learn the process.
### Built With
As mentioned it is a React Package, therefore React will be the JS library used for this package. Created using React version ^18.1.0.
* [React.js](https://reactjs.org/)
* [Storybook.js](https://storybook.js.org/)
* [Rollup.js](https://rollupjs.org/guide/en/)
* [Nautilus](https://chrome.google.com/webstore/detail/nautilus-wallet/gjlmehlldlphhljhpnlddaodbjjcchai)
* [Currently implementing SAFEW]()
## Getting Started
Here we will explain how to properly use the package.
### Prerequisites
Although these are very obvious requisites, and surely installed by any web developer, they are:
* Node.js
```sh
https://nodejs.org/
```
* npm (Although this is likely installed by installing Node)
```sh
npm install npm@latest -g
```
* Nautilus^0.4.0
```sh
https://chrome.google.com/webstore/detail/nautilus-wallet/gjlmehlldlphhljhpnlddaodbjjcchai
```
* SAFEW^0.6.3 (Still in development check safewImplementation branch.)
```sh
https://chrome.google.com/webstore/detail/simple-and-fast-ergo-wall/fmpbldieijjehhalgjblbpgjmijencll/
```
### Installation
How to install, import and use the Ergo dApp Connector in your code!
* Install the package.
```sh
npm install ergo-dapp-connector
```
## Usage
[Quick video doing this steps](https://twitter.com/NightOwlCasino/status/1529452399475179520)
* Import the dApp Connector in the .js file where you will be using it
```sh
import {ErgoDappConnector} from "ergo-dapp-connector";
```
* Call the component ErgoDappConnector that you just imported anywhere in your code where you want to display it.
```sh
```
With the attribute "color" you can specify the color you want your "Connect Wallet" button to be!
The current supported colors are:
orange
white
black
green
purple
blue
red
yellow
brown
pink
teal
cyan
coral
emerald
inkwell
darkred
darkgreen
darkblue
darkpurple
darkorange
## Extra
No project has ever implemented SAFEW as a wallet choice to connect to their dApp, we believe SAFEW deserve more love from the community, and since it has some fan base we decided to take the package a bit further than what our main goal was and implement Nautilus AND Safew compatibility, it will be a very nice addition to the Ergo dApp Connector and to the whole Ergo ecosystem, we are working alongside with Hailey(Safew creator) at the moment to make this happen, but we want to show a quick sneak peak of how testing is going [here](https://twitter.com/NightOwlCasino/status/1531482604368760832)
The more wallets to choose, the better.
PS: However, as we stated before in the readme, the package is already working and can be used by everyone with Nautilus, the goal for ErgoHack was a success, this is just some extra implementation we wanted to mention for the ErgoHack submission.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue!
1. Fork the Project
2. Commit your Changes (`git commit -m 'Add some Amazing Feature'`)
3. Push to the Branch (`git push origin feature/AmazingFeature`)
4. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` file for more information.
## Contact
Night Owl - [@NightOwlCasino](https://twitter.com/NightOwlCasino)
Night Owl Links - [Linktr](https://linktr.ee/NightOwlCasino)
Author Project Link: [Night Owl Casino Github](https://github.com/nightowlcasino/)
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/nightowlcasino/dApp-connector-react-package/graphs/contributors
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/nightowlcasino/dApp-connector-react-package/blob/main/LICENSE