Pristine TypeScript React Jade

Pristine-typescript-react-jade is a starting point for new and existing projects to create peer-to-peer decentralized applications. This repo is a a fork of pristine-typescript-react and utitlizes Jade, a suite of tooling for DApps.

The goal of Jade is to provide a suite of tools to enable the creation of truly peer-to-peer applications on top of EVM-based blockchains like Ethereum Classic.

Screenshot

Install

While the repo can be downloaded, cloned, or forked, the Pritine-CLI makes it super easy to select a Pristine based template and related repositories.

Dependencies

• at least node v10.15.3
• at least npm v6.4.1
• pristine-cli (recommended)

Generate a project based on pristine-typescript-react-jade with the Pritine-CLI.

pristine-cli <PROJECT NAME>

# Follow the prompts and
# select 'pristine-typescript-react-jade'

Usage

Install package dependencies.

npm install

The project utilizes Jade Service Runner to run an EVM based client in the background. To run the app and background-service, run the following commands seperately.

npm start
# Runs instance of the app http://localhost:3000/

npm run service-runner
# Runs MultiGeth service, configured to ETC mainnet by default.
# Runs at http://localhost:8002/

Where's the blockchain data? Jade Service Runner conveniently creates and stores service data in the /services/ directory in the project.

.
├── node_modules
├── public
├── services
│   └── multi-geth *
└── src

Contributing

Getting Started

To get started, fork or duplicate the repository. Then edit this file and delete everything above this line.

Then edit the package.json and change the name and homepage fields to match your newly created repository.

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

Conventions and Specifications

This repository has some strong opinions built in like circleci, semantic-release, npm. So feel free to fork and change it at your own discretion. It is only meant to be a starting point. That being said:

Using conventions, documentation and specifications make it easier to:

• communicate the problem you are solving
• ease onboarding
• build and use composable tools
• promote open source contribution and engagement
• promote issue and feature discussion on Github itself

Resources

• Generate Pristine based Projects with the Pristine-CLI
• Pristine-CLI repo
• Jade Service Runner repo

Documenation Driven Development:

• Pristine
• opensource.guide
• Github community profiles for public repositories
• Readme Driven Development
• pengwynn/flint
• Working Backwards
• Literate programming
• Hammock Driven Development
• Inversion and The Power of Avoiding Stupidity
• choosealicense.com