Skip to content
forked from treejer/contract

📝 Core smart contracts of the Treejer protocol

License

Notifications You must be signed in to change notification settings

Bere333/contract

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Treejer Protocol Smart Contracts

Background Image Twitter Follow License: GPL v3 CircleCI Coverage Status Contributor Covenant

Treejer Protocol Smart Contracts is a lightweight implementation of the Treejer Protocol on Polygon.

In-depth documentation on Treejer protocol and the latest deployed contracts addresses are available at Treejer Docs.

Visit Treejer Blog for more details into the Treejer and how it works.

Local Development

The following assumes the use of node@>=13.

Install Dependencies

npm install

Start Ganache

npm run ganache

Test

npm run test

Deploy on local ganache

npm run deploy

Development using Docker

In order to facilitate better development and testing, the project has been integrated with Docker and Docker Compose. This eliminates the necessity to setup the environment in your local machine. Simply spin up the container and start developing and testing in it.

Requirements

  • Docker - If you don't have Docker installed in your local machine, you can get it by following the steps here. This should also install docker-compose.

Setup

Two modes can be enabled via docker:

  • Development: This creates a container with the project and all the dependencies installed in it. The project location in your local machine will be linked as a volume to the container and any edits you make in your local would be synced to the container. To spin up the development container use: docker-compose up develop
  • Testing: This brings up a container and runs all the tests in it automatically and can be used purely for testing purposes. To spin up a testing container use: docker-compose up test

How to Contribute

To chat with us & stay up to date, join our Discord.

Vulnerabilities should be disclosed directly to the Treejer team by emailing [email protected].

© Copyright 2021, Treejer

Translations 🌎

About

📝 Core smart contracts of the Treejer protocol

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 81.9%
  • Solidity 17.4%
  • Other 0.7%