Skip to content

Commit

Permalink
📝 doc: Adjust the readme regarding GUI content
Browse files Browse the repository at this point in the history
  • Loading branch information
Liquidwe committed Dec 8, 2024
1 parent 15cd6b3 commit 582bace
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 86 deletions.
92 changes: 6 additions & 86 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The vision of Manuscript is to realize “data trade” within the Chainbase net
curl -fsSL https://github.com/chainbase-labs/manuscript-core/raw/main/install-gui.sh | bash
```
### GUI
![manuscript-gui](./images/manuscript-gui.jpg)
![manuscript-gui](./images/manuscript_gui_1.jpg)

### Requirements
[Docker Desktop 25.1+](https://www.docker.com/products/docker-desktop/)
Expand All @@ -63,95 +63,15 @@ curl -fsSL https://github.com/chainbase-labs/manuscript-core/raw/main/install-g

Here's an example of how to <b>process</b> data from chainbase with manuscript:

#### 1. After installing `manuscript-cli`, you can initialize the Manuscript scripts and environment using the command
```bash
➜ manuscript-cli --help
Chainbase Manuscript ™ Build The World\'s Largest Omnichain Data Network 🚀 🚀 🚀
─────────────────────────────────────────────────────────────────────────────────
Usage:
manuscript-cli [command] [flags]
#### 1. Selecting data and creating local tasks

Available Commands:
init Initialize and start local manuscript containers
list List all manuscript jobs
logs View logs of a manuscript job
stop Stop a manuscript job
deploy Deploy Manuscript to a local environment or the Chainbase network.
```
#### 2. **manuscript-cli init**: Use the client to initialize the `manuscript.yaml` file for a local standalone container environment
```bash
➜ manuscript-cli init
🏂 1. Enter your manuscript name: (default is demo)
7...
6: Polygon_zkEVM (Database: zkevm)
5: Avalanche (Database: avalanche)
4: Base (Database: base)
3: Arbitrum_One (Database: arb1)
2: Bsc (Database: bsc)
1: Ethereum (Database: ethereum)
🏂 1.Enter your chain choice (default is zkevm):

🧲 2.Please select a table from the list below:
1: blocks
2: transactionLogs
3: transactions
Enter your choice (default is blocks):
✔ No input provided. Defaulting to table: blocks

📍 3.Please select a data output target:
1: Postgresql
2: Print (output to console)
Enter your choice (default is Postgresql):
✔ No input provided. Defaulting to output target: postgres
![manuscript-gui](./images/manuscript_gui_2.jpg)

🏄🏄 Summary of your selections:
Selected manuscript name: demo
Selected chain: zkevm
Selected table: blocks
Data output target: postgres
#### 2. Waiting for the task to run and use the data

🚀 Do you want to proceed with the above selections? (yes/no): yes
···
✓ Step 5: Start Docker Containers, which was completed successfully!
⠙ Step 6: Check Container Status Loading... ✓ Container demo is running
✓ Step 6: Check Container Status completed successfully!
🎉 Manuscript demo deployment completed successfully!
You can now list your job with the command:
👉 manuscript-cli list
![manuscript-gui](./images/manuscript_gui_3.jpg)

If you need to manually edit the manuscript, you can edit the file '/Users/azroa/github/manuscript/demo/manuscript.yaml' and then manually execute the 'deploy' command:
👉 vim /Users/azroa/github/manuscript/demo/manuscript.yaml
👉 manuscript-cli deploy /Users/azroa/github/manuscript/demo/manuscript.yaml --env=local
```
#### 3. List the job to check the status of the job
```bash
manuscript-cli list
🟢 1: Name: demo | State: RUNNING | Start Time: 2024-10-08 14:26 | Duration: 3 minutes | GraphQL: http://127.0.0.1:8082

manuscript-cli logs demo
···logs···
```
#### 4. Access the GraphQL endpoint to query the data(GraphQL: http://127.0.0.1:8082)
![graphQL](./images/graphQL.jpg)
#### 5. Deploy the Manuscript to the Local Environment or the Chainbase Network(the network is coming soon...)
```bash
# 1. cat the manuscript_config.ini file
~ cat $HOME/.manuscript_config.ini
baseDir = /Users/azroa/github

[demo]
name = demo
···

# 2. vim the manuscript.yaml file
vim ~/github/manuscript/demo/manuscript.yaml

# 3. Deploy the Manuscript to the Local Environment
manuscript-cli deploy ~/github/manuscript/demo/manuscript.yaml --env=local
or
manuscript-cli deploy ~/github/manuscript/demo/manuscript.yaml --env=chainbase
```
😆😆 data has never been so simple...

### Key Concepts
There are two primary objects:
Expand Down
File renamed without changes
Binary file added images/manuscript_gui_2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manuscript_gui_3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 582bace

Please sign in to comment.