Forge React Starter

Brings tons of thousands react libraries/components to dApps that run on forge powered blockchain.

Live preview

A starter project that integrates forge javascript sdk with mainstream javascript application batteries:

• React.js the framework for view layer
• Next.js for crafting pages and SSR
• Material-UI for resuable react components
• Express.js as custom web server that can serve custom api
• Mongoose as database ORM layer

Forge SDK libraries included in the starter project:

• @arcblock/graphql-client as communication layer between application and forge powered blockchain
• @arcblock/did-auth help application do jwt based auth with ABT wallet
• @arcblock/did-auth-storage-mongo storage engines that powers the magic behind ABT Wallet qrcode scanning
• @arcblock/react-forge react components that can implements basic UI elements to connect your application with ABT Wallet, such as avatar and auth dialog

Other javascript project goodies:

• jwt: token based authentication
• eslint: for consistent coding style
• prettier: for consistent code formatting
• husky: and lint-staged for prepush and precommit hooks
• nodemon: for auto restart server on node.js code change
• next.js: supports hot reload on client code change
• dotenv: to load configurations from .env files

Folder Structure

.
├── LICENSE
├── Makefile
├── README.md
├── app.js                    // application entry file
├── client                    // code for client side pages
│   ├── babel.config.js       // custom babel configuration
│   ├── components            // shared react components/layouts across all pages
│   ├── hooks                 // shared react hooks
│   ├── libs                  // shared utility code
│   ├── next.config.js        // custom next.js configuration
│   ├── pages                 // pages
│   └── static                // static assets that can be loaded by browser
├── package.json
├── server                    // backend code
│   ├── libs                  // shared server libs
│   ├── models                // mongoose db models
│   └── routes                // express routes and handlers
├── version
└── yarn.lock

Runtime Requirements

• Mongodb v3+
• Node.js v10+
• That's all

Usage

Create new project with forge-cli

npm install -g @arcblock/forge-cli forge-react-starter
forge init
forge start
forge create-project hello-forge
cd hello-forge
npm start

Just use this starter repo

Note: You have to setup an .env file manually.

git clone https://github.com/ArcBlock/forge-react-starter.git
cd forge-react-starter
yarn

Configuration

dApp configuration file is auto generated and stored in .env, example configure as:

MONGO_URI="mongodb://127.0.0.1:27017/forge-starter"
COOKIE_SECRET="71548f479c310ebc5bd972"
CHAIN_ID="forge"
CHAIN_HOST="http://192.168.1.6:8210/api"
APP_NAME="Forge Starter"
APP_PORT="3030"
APP_SK="0xd8ee2e2b73e0f3d7b7c5d53"
APP_ID="zNKtrS7etp2WQYnbVtknbDrVa23Q3eycdcDw"
BASE_URL="http://192.168.1.6:3030"
APP_TOKEN_SECRET="5bd972379d6bdd0bd4badf49b8944994f7e2c4d3bab03c3d"
APP_TOKEN_TTL="1d"

Caution: .env contains very sensitive info such as Application wallet secret key, PLEASE DO NOT COMMIT .env FILE

FAQ

How to upgrade @arcblock/* dependencies?

Simple, just update package.json, then yarn, be sure to test the starter after upgrading.

How to deploy my application?

Checkout Deployment.md

What APIs are supported by GraphQLClient?

Checkout the following screenshot or just run the starter and open browser console.

LICENSE

Copyright 2018-2019 ArcBlock

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.