Getting Started with Create Blocklet

This project was bootstrapped with Create Blocklet.

This blocklet is a dapp project, which means this is a full-stack application. It's contained both server and client code.

File Structure

screenshots/ - Screenshots
api/ - Api side code
- hooks/ - blocklet lifecycle hooks
- libs/ - Api side libraries
- middlewares/ - Api side middlewares
- routes/ - Api side routes
- index.js - Api side entry point
.env - Environment variables
.env.local - Local environment variables
.prettierrc - Prettier configuration
blocklet.md - Blocklet README
blocklet.yml - Blocklet configuration
LICENSE - License file
logo.png - Blocklet logo file
Makefile - Makefile
package.json - Npm package file
README.md - A guide for this blocklet
version - Version file

Development

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
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
Go to the project directory cd [name]
Install dependencies: npm install or yarn
Start development server: blocklet dev

Bundle

After developing a blocklet, you may need to bundle it. Use npm run bundle command.

Deploy

If you want to deploy this blocklet to local blocklet server, you can use blocklet deploy .blocklet/bundle command(Make sure the blocklet is bundled before deployment).

Or you can simply use npm run deploy command.

If you want to deploy this blocklet to remote blocklet server, you can use the command below.

blocklet deploy .blocklet/bundle --endpoint {your blocklet server url} --access-key {blocklet server access key} --access-secret {blocklet server access secret}

Make sure the blocklet is bundled before deployment.

Upload to blocklet store

If you want to upload the blocklet to any store for other users to download and use, you can following the following instructions.

Bump version at first.
```
make bump-version
```
Then config blocklet store url. You can use those store url in below.
1. https://store.blocklet.dev/
2. https://dev.store.blocklet.dev/
3. A blocklet store started by yourself.
  
  Make sure you have installed a blocklet store on your own blocklet server. Check it on here: https://store.blocklet.dev/blocklet/z8ia29UsENBg6tLZUKi2HABj38Cw1LmHZocbQ
```
blocklet config set store {store url}
```
Get a accessToken by using this command.

Why we need a accessToken?
A accessToken is genrate by blocklet store, which help us upload our blocklet to any store.

Set accessToken to blocklet config
```
blocklet config set accessToken {accessToken}
```
Upload a new version to a store.

Make sure the blocklet is bundled before upload.
```
blocklet upload
```
Or you can simply use npm run upload command.
You also can upload a new version to a store by Github CI.
Bump version at first.
```
make bump-version
```
Push your code to Github main/master branch, or make a pull request to the main/master branch.
The CI workflow will automatically upload a new version to a store.

Q & A

Q: How to change a blocklet's name?

A: Change the name field in the package.json file, change the name field in the blocklet.yml file.

You can also change the title field and description field in the blocklet.yml file.

Run blocklet meta command, you will get a did config, copy the did value.

Replace this command "bundle:client": "PUBLIC_URL='/.blocklet/proxy/{did}' npm run build", in package.json

Replace did field in the blocklet.yml
Q: How to change a blocklet's logo?

Change the logo.png file root folder.

Or you can change the logo field in the blocklet.yml file.

Make sure you have added the logo path to the blocklet.yml file files field.

Learn More

Full specification of blocklet.yml: https://github.com/blocklet/blocklet-specification/blob/main/docs/meta.md
Full document of Blocklet Server & blocklet development: https://docs.arcblock.io/abtnode/en/introduction

License

The code is licensed under the Apache 2.0 license found in the LICENSE file.

xiaobaiha/etherscan-crawler