Tellor Frontend Boilerplate

This project is a GitHub template used to quickly start up Tellor Frontends. To add more features so all Tellor web3 apps can share the functionality, click on 'Request Feature' below and be sure to detail your specs.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

The idea behind the frontend boilerplate is to cut down development time, by creating a reusable module that contains helpful, necessary and reoccurring web3 frontend capabilities. This includes, but is not limited to:

• MetaMask/WalletConnect connectivity
• Light/Dark Mode
• Consistent Navbar and Footer

A .prettierrc.js file is included so that if you use the prettier extension, you can set your settings in your text editor to only format on save if this file is present. This way you can keep your formatting preferences unique to your local machine and only affect repos that contain a file like this. This keeps other projects in Tellor.io with whatever formatting is unique to the developers working on them.

Built With

• React
• web3
• ethers.js
• jazzicon-react
• Material UI

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• This app requires node version 16.14.0 in order to run.
• We suggest installing nvm globally

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

• Check nvm version after install

  nvm -v 

  Ex:

  0.39.1

Installation

1. Clone the repo in your preferred directory

   git clone https://github.com/tellor-io/frontendBoilerplate.git

2. Install NPM packages

   npm install

3. Change node version to 16.14.0

   nvm use v16.14.0

   Output:

   Now using node v16.14.0 (npm v8.3.1)

4. Spin up your local development server

   npm start

Usage

Use this project to quickly spin up new Tellor frontends! Below are some examples of Tellor apps that use this template:

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Tellor.io

• Documentation
• Twitter
• Discord
• GitHub
• YouTube

Acknowledgements

• README Acknowledgement