Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 1.98 KB

README.md

File metadata and controls

65 lines (46 loc) · 1.98 KB
Raw

Getting Started with Create Blocklet

This project was bootstrapped with Create Blocklet.

This project is a monorepo project, which means that there are multiple blocklet applications.

File Structure

  • .prettierrc - Prettier configuration
  • LICENSE - License file
  • Makefile - Makefile
  • package.json - Npm package file
  • eslintrc.js
  • lerna.json
  • README.md - A guide for this blocklet
  • version - Version file
  • .gitignore
  • .npmrc
  • scripts/
    • batch-modify-deps-version.mjs
    • bump-version.mjs
  • blocklets/ - Blocklet applications
  • websites/ - Static website

Development

  1. Make sure you have @blocklet/cli installed

    Blocklet needs blocklet server as a dependency. So you need to install it first.
    npm install -g @blocklet/cli
    See details in https://docs.arcblock.io/abtnode/en/introduction/abtnode-setup#use-the-binary-distribution

  2. Init blocklet server & start blocklet server

    Before starting an blocklet server, you need to init blocklet server.
    blocklet server init --mode=debug
    blocklet server start
    See details in https://docs.arcblock.io/abtnode/en/introduction/abtnode-setup#configure-abt-node

  3. init project

 make init
  1. Go to the main blocklet directory cd blocklets/[main blocklet] or cd websites/[main blocklet]
  2. Start development server: npm run dev
  3. Go to the other websites directory cd blocklets/[other blocklet] or cd websites/[main blocklet]
  4. Start development server: npm run dev:child

update version

npm run bump-version

Reference

Our docs site is generate by Create Blocklet itself.

We use Blocklet Page to write our docs

check more details on