Mibao

The web app of Mibao.

Quick start

Prerequisites

You will need node >= 14 and yarn >= 1.22 to build and run Mibao. Run command:

$ yarn

to install dependencies.

Start local development server

After Node.js and yarn has been installed, run this command to start a local development server:

$ yarn dev

Development

Tech stack

• React, UI library

• React Router, router

• Chakra UI, UI Components

• Create React App/craco, Bundle tool

• Jotai, State managements

• pw-core, CKB SDK for dApps

In summary, Mibao is a React-based single-page application that implements routing via react-router. Mibao generates pure HTML/CSS/JavaScript files and does not require a server with a specific back-end language to run it.

File Structure

./src
  ├── App.css # entry css file
  ├── App.tsx # entry React component
  ├── apis # API impl
  ├── assets # static assets
  ├── cache # storage cache
  ├── components # common components
  ├── constants # constants variable
  ├── favicon.svg
  ├── hooks # custom React hooks
  ├── i18n # locale files
  ├── index.tsx # entry file
  ├── mock
  ├── models # TypeScript models
  ├── pw # pw-core interactions
  ├── react-app-env.d.ts #
  ├── routes # react router config
  ├── styles # common styles
  ├── utils
  └── views # route component

Note that <ROOT>/.env.example includes both the mainnet/testnet environment variables. The compiled files are generated in the <ROOT>/build folder.

Contribution

Please make sure that the Pull Request follows the requirements in PULL REQUEST TEMPLATE.

License

Mibao is released under the terms of the Apache-2.0 license.