GitHub | Wiki | Forum | Blog | LinkedIn | Twitter

Sovryn DApp

---

Browsers support

Edge	Firefox	Chrome	Safari	iOS Safari	Opera	Brave
last 10 versions	last 10 versions	last 10 versions	last 6 versions	last 6 versions	last 10 versions	last 10 versions

Install & Start

Prerequisites

• Make a fork of this repository and clone it to your machine.

• Make sure you use at least version 12 of Node.js.

  • To install Node.JS as a Windows user, download the required installation from the Node.js website.

  • To install Node.JS as a Linux or macOS user:

    • sudo dnf module install nodejs:12

  • To reset the older Node.JS installation so that you can upgrade to version 12:

    • sudo dnf module reset nodejs

    NOTE: Alternatively, You can use the NVM tool that is easy to use and allows you to switch between the installed node versions. For more information, see the NVM guide.

Procedure

1. Navigate to your cloned repository and install the yarn tool:

   yarn install

   Yarn dependencies packages will be downloaded.

2. Start DApp server:

• For development testnet:

  yarn start

• For development mainnet:

  yarn start:mainnet

• For a production build:

  yarn build

Contributing

Guides

Please read our docs page for step by step guides on how to add new tokens, amm pools and etc:

• Guides & Tutorials
• Running on Apple with M1 chip

Bug Reports

To foster active collaboration, Sovryn strongly encourages the creation of pull requests rather than just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.

However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.

Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem. If you want to chip in, you can help out by fixing any bugs listed in our issue trackers.

Support Questions

Sovryn's GitHub issue trackers are not intended to provide help or support. Use one of the following channels instead:

• Discord
• Wiki Pages
• Sovryn Forum
• Sovryn Blog

Core Development Discussion

You may propose new features or improvements of existing DApp behavior using the Sovryn Ideas issue board. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.

Informal discussion regarding bugs, new features, and implementation of existing features takes place in the #sorcery channel of the Sovryn Discord server.

Which Branch?

The development branch acts as a testnet containing the latest changes. The master branch is production branch for the alpha.sovryn.app. Depending on your feature you are contributing with, select the proper branch as a starting point. Most of the time, it will be the development branch unless you provide hotfixes or features that should be released before other features - then it can be master. By doing so, we merge all features to development and then development to master to make one big release batch.

All bug fixes should be sent to the latest stable master branch. Bug fixes should never be sent to the development branch unless they fix features that exist only in the upcoming release.

Minor features that are fully backward compatible with the current release may be sent to the latest stable branch.

Major new features should always be sent to the development branch, which contains the upcoming release.

Ask in the #sorcery channel of the Sovryn Discord server when unsure if the feature qualifies as major or minor.

Working With UI

All UI designs used for this repository should be available publically in Google Drive folder as Adobe XD files

Storybook

We use Storybook to provide API style docs and examples for our UI components. Any new components should have stories added to them that include all available properties that can be passed in, and some specific examples for major common variations. For specific implementation examples, you can search the codebase for files named index.stories.tsx.

To test components via Storybook on your local machine:

• run yarn install on your working branch.
• run yarn storybook to load the development server.
• access Storybook dev server on localhost:6006.
• if the docs fail to load and you see an error cannot read properties of undefined (reading 'storyStore'), the package installation is likely broken and you will need to clear node_modules folder and follow first two steps again.
• changes can now be made to index.stories.tsx files and the development server will hot-reload automatically.

To test components on a deployed PR link, simply append /storybook to the end of the deployed URL.

Security Vulnerabilities

If you discover a security vulnerability within DApp, please submit your bug report to Immunefi (there are bounty rewards). All security vulnerabilities will be promptly addressed.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Licence

The Sovryn DApp is open-sourced software licensed under the MIT license.