GitHub | Wiki | Forum | Blog | LinkedIn | Twitter
 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 |
-
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.
-
-
Generate the GitHub Personal Access Token (PAT) and copy the token code:
-
Using your GitHub profile Drop-down menu, navigate to Settings -> Developer settings.
-
Select the Personal access tokens option and click the Generate new token button.
-
Fill in the token information as follows:
a) Describe the token using the Note field.
b) Set expiration to No expiration.
c) Select the all repo and write:packages options, including the read:packages.
-
Click the Generate Token button at the bottom of the page.
-
Copy your generated token code for later.
-
-
Create the
~/.npmrcfile in your home dirrectory. In a case you already have one, just add the line in the next step. -
Add the following content to the
~/.npmrcfile and replace the field with your PAT value copied from GitHub:@distributedcollective:registry=https://npm.pkg.github.com //npm.pkg.github.com/:_authToken=<Your-GitHub-token-here>
-
Save the file and restart your terminal.
-
Navigate to your cloned repository and install the
yarntool:yarn install
Yarn dependecies packages will be downloaded.
-
Start DApp server:
-
For development testnet:
yarn start
-
For development mainnet:
yarn start:mainnet
-
For a production build:
yarn build
NOTE: If you are using a Windows machine then you may receive errors when running this command, related to shell scripts in /bin not including the .sh file extension. To avoid this please run yarn --ignore-scripts instead, and execute the gh-pack script manually as needed.
Due to the terms of our licensing agreement with TradingView, we cannot grant access to the charting-library repository to external contributors. To allow running this repository locally, we have set up the development_external and master_external branches that exclude this dependency and are synced to the latest changes from development/master branches.
Any new Pull Requests should target the non-external versions of these branches as outlined in the "Which Branch?" section below.
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.
Sovryn's GitHub issue trackers are not intended to provide help or support. Use one of the following channels instead:
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.
The development branch acts as a testnet containing the latest changes. The master branch is production branch for the live.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.
All UI designs used for this repository should be available publically in Google Drive folder as Adobe XD files
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.
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.
The Sovryn DApp is open-sourced software licensed under the MIT license.