Skip to content

Latest commit

 

History

History
137 lines (86 loc) · 11.7 KB

README.md

File metadata and controls

137 lines (86 loc) · 11.7 KB
Raw

GitHub | Wiki | Forum | Blog | LinkedIn | Twitter | Discord

Sovryn Dapp

Browsers support

IE / Edge
Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari		 iOS Safari
iOS Safari		 Opera
Opera		 Opera
Brave
last 5 versions last 5 versions last 5 versions last 5 versions last 5 versions last 5 versions last 5 versions

What's inside?

This is a turborepo for the Sovryn dapp and it's associated packages.

Apps and Packages

  • frontend: Sovryn dapp Frontend. Utilizes other packages in this repo and sovryn-onboard to provide Web3 interactions
  • @sovryn/ui: Sovryn UI Library. Suite of React Typescript UI components that can be used in any dapp that wants to adhere to Sovryn UX
  • @sovryn/contracts: smart contract definition including ABIs, token details, contract addresses for all chain environments, and utility functions for interacting with Sovryn smart contracts. Further details on contracts used here can be found in the various DistributedCollective repositories.
  • @sovryn/ethers-provider: helper functions for accessing ethers static provider
  • @sovryn/utils: general helper utilities used across our packages
  • @sovryn/eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • @sovryn/tailwindcss-config: tailwindcss configuration
  • @sovryn/tsconfig: tsconfig.jsons used throughout the monorepo

Development

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

  • Make sure you use at least version 18 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.

  • When running the frontend app locally, environment variables are loaded from apps/frontend/.env.local. If this file does not exist then it should be created with the format outlined in apps/frontend/.env.example, or the UI may fail to load.

# install dependencies
yarn install
# run all apps on development mode
yarn dev
# run storybook
yarn storybook
# run tests
yarn test

Error resolution

husky package not available

When using NVM and committing code changes, you may receive a "package 'husky' not found" error. Assuming this is already installed on your machine (by yarn install) then you may need to add the file ~/.huskyrc with the following contents:

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"

module not found

If "module not found" errors are encountered when running yarn test or from husky precommit checks, then please make sure packages are built first by running yarn dev or yarn build from root directory.

Contributing

Guidelines

Find out all about our working practices on our wiki here.

Support Questions

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

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.

Which Branch?

The develop branch acts as a testnet containing the latest changes. The main branch is production branch for the site hosted at 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 develop branch unless you provide hotfixes or features that should be released before other features - then it can be main. By doing so, we merge all features to develop and then develop to main to make one big release batch, after full testing and review.

All bug fixes should be sent to the latest stable main 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 develop branch, which contains the upcoming release.

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

Working With Sovryn UI LIbrary

All UI components for general use are located in @sovryn/ui package. Each component must include a Storybook example and Jest tests that verify functionality is working as intended. Components should not include implementation specific details (e.g. contract addresses, complex state, hardcoded text), and instead expose these via component props. Figma designs for all components, and general design guidelines that we followed when constructing this library, can be found in the links here.

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 filenames ending in .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 .stories.tsx files and the development server will hot-reload automatically.

To test components on a deployed PR link, look for sovryn-storybook comment in PR thread. If you would like to see the existing components in the Sovryn UI Library without running the code locally, the latest Storybook built from our develop branch can always be found here.

Security Vulnerabilities

If you discover a security vulnerability within the dapp code in apps/frontend, 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. A full written version can be found here.

Licence

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