Brings tons of thousands react libraries/components to dApps that run on forge powered blockchain.
A starter project that integrates forge javascript sdk with mainstream javascript application batteries:
- 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/forge-sdk 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/did-react 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 authenticationeslint
: for consistent coding styleprettier
: for consistent code formattinghusky
: andlint-staged
for prepush and precommit hooksnodemon
: for auto restart server on node.js code changenext.js
: supports hot reload on client code changedotenv
: to load configurations from.env
files
.
├── LICENSE
├── Makefile
├── README.md
├── app.js // application entry file
├── src // 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
├── api // backend code
│ ├── libs // shared server libs
│ ├── models // mongoose db models
│ └── routes // express routes and handlers
├── version
└── yarn.lock
- Mongodb v3+
- Node.js v10+
- That's all
npm install -g @arcblock/forge-cli forge-next-starter
forge install
forge start
forge project:create hello-forge
cd hello-forge
npm start
Note: You have to setup an
.env
file manually.
git clone https://github.com/ArcBlock/forge-dapp-starters.git
cd forge-dapp-starters/packages/forge-next-starter
yarn
yarn start
dApp configuration file is auto generated and stored in .env
, example configure as:
# server only
MONGO_URI="mongodb://localhost/forge-next-starter"
APP_TOKEN_SECRET="you_should_change_this"
APP_TOKEN_TTL="1d"
APP_SK="0x95d4ef0af090e1cf21b9fd0ccefe768a7bff660375b0bfdb95a34a4106a68bf7f7995a7066cd1171b4e963f2b36de17eb642c4145d58733cfa9b03a11bb5f11e"
APP_PORT=3030
# both server and client
CHAIN_ID="zinc-2019-05-17"
CHAIN_HOST="https://zinc.abtnetwork.io/api"
APP_ID="zNKrVwYxwgsYAUX3mGjK42oNuePLVT3Me6ga"
APP_NAME="Forge Next.js Starter"
BASE_URL="http://10.113.10.82:3030"
API_PREFIX=""
Caution:
.env
contains very sensitive info such as Application wallet secret key, PLEASE DO NOT COMMIT.env
FILE
Simple, just update package.json
, then yarn
, be sure to test the starter after upgrading.
Checkout Deployment.md
Checkout the following screenshot or just run the starter and open browser console.
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.