dapp-starter-kit

This is a starter-kit for creating a dApp on the nOS platform

Getting started

To get started, go to our Getting Started guide. Afterwards you can check out the nOS API documentation

Purpose

The goal of this project is to provide a quickstart for creating nOS dApps with React and various dependencies already installed and configured.

In this repo you can find NEO specific tooling:

nOS functions exposed in a store
neon-js, providing extra NEO functionality

Also general frameworks and tooling:

React, our framework of choice
JSS, CSS in JSS
Jest, a testing framework
Babel and Parcel, transpiling and compiling
Prettier and ESLint, kickass linting support

Some plugins:

vendor prefixing, camelCase and global styling JSS plugins
env and React Babel presets
babel-polyfill
React and Prettier ESLint plugins

And finally some testing and security:

Circle CI, automated builds/testing (coming soon)
Coveralls, code coverage (coming soon)
Deepscan and Better Code Hub, code analysis (coming soon)
Renovate and Gemnasium, dependency monitoring (coming soon)

Setup

$ git clone https://github.com/nos/dapp-starter-kit.git my-dapp
$ cd my-dapp
$ yarn
$ yarn start

Change README.md and package.json to fit your project needs. Delete LICENSE if not applicable.

Testing

Use yarn test:local or npm run test:local to run all tests locally. The test command is reserved for CI builds.

Document structure

react-stack-boilerplate
├── src
│   ├── __helpers__
│   ├── __mocks__
│   ├── assets
│   ├── components
│   │   └── __tests__
│   │       └── __snapshots__
│   ├── nos
│   └── views
│       └── __tests__
│           └── __snapshots__
├── .babelrc
├── .eslintrc
├── .gitignore
├── CHANGELOG.md
├── jest.config.js
├── jest.setup.js
├── package.json
├── README.md
└── yarn.lock

Known issues

Build assets to dedicated subdirectory parcel-bundler/parcel#233
Bundler sometimes freezes on Windows parcel-bundler/parcel#900

adrianbarwicki / dapp-starter-kit