Skip to content
Starter web application that uses forge javascript sdk + did sdk and react
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.makefiles chore: add readme and version bump files May 8, 2019
client fix: travis build: eslint errors May 21, 2019
docs chore: update docs May 11, 2019
server chore: update dependency May 22, 2019
tools chore: make auto publish work May 21, 2019
.editorconfig chore: add readme and version bump files May 8, 2019
.eslintrc.js fix: travis build: eslint errors May 21, 2019
.gitignore chore: debug serverless May 10, 2019
.prettierrc chore: add eslint/husky/lint-staged May 8, 2019
.travis.yml chore: fix travis export May 21, 2019
CHANGELOG.md chore: bump version May 21, 2019
LICENSE chore: update readme May 9, 2019
Makefile chore: make auto publish work May 21, 2019
README.md chore: update readme May 21, 2019
app.js fix: dev server May 17, 2019
netlify.toml
package.json chore: update dependency May 22, 2019
starter.config.js chore: update starter spec comments May 21, 2019
version chore: bump version May 21, 2019
yarn.lock chore: update dependency May 22, 2019

README.md

Forge React Starter

Netlify Status

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:

Forge SDK libraries included in the starter project:

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=3600

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.

You can’t perform that action at this time.