Skip to content

thebadge/thebadge-dapp

Repository files navigation

TheBadge DApp Front-End

Join to Discord contributions welcome Follow us on Twitter MIT licensed Latest release

For questions or request information reach out via Discord.

Deployed environments

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

We use nvm to ensure that everyone is using the same Node Version. Please install it and run nvm use

We use yarn in our infrastructure, so we decided to go with yarn in the README. Please install yarn globally if you haven't already.

Installing and running

Install dependencies for the project:

yarn install

Make a copy of the .env.example and fill the empty values, if you don't know how to do it, reach any of the team members, and they will be happy to help


To launch the dev version of the app locally:

yarn dev

Building

To get a complete bundle use:

yarn build

File structure

Inside the src folder you will find:

  • components: Stateless components. UI.
  • contracts: All the contracts the dApp will interact.
  • hooks: React hooks.
  • pagePartials: Complex components related to a particular page.
  • providers: React providers.
  • subgraph: Queries and configuration for Subgraph's.
  • theme: General UI styles.
  • utils: Some utility functions.
  • config: Global configurations.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is released under the MIT License - see the LICENSE.md file for details.

Releases

No releases published

Packages

No packages published