This is an Observable Framework repo structure with some data gathering scripts for the Arweave checker PoC. The checker scripts are in the /src/scripts folder.
Run
npm install
Then you can run
node ./src/scripts/ping.js
to run a ping test on the arweave nodes in /src/data/arweave-nodes.json
And you can run
node ./src/scripts/retrieve.js
to retrieve the sample transactions in /src/data/random-transactions.json from the nodes in /src/data/arweave-nodes.json
Then follow the below steps to see the data visualised in the Observable dashboard
This is an Observable Framework app. To install the required dependencies, run:
npm install
Then, to start the local preview server, run:
npm run dev
Then visit http://localhost:3000 to preview your app.
For more, see https://observablehq.com/framework/getting-started.
A typical Framework project looks like this:
.
├─ src
│ ├─ components
│ │ └─ timeline.js # an importable module
│ ├─ data
│ │ ├─ launches.csv.js # a data loader
│ │ └─ events.json # a static data file
│ ├─ example-dashboard.md # a page
│ ├─ example-report.md # another page
│ └─ index.md # the home page
├─ .gitignore
├─ observablehq.config.js # the app config file
├─ package.json
└─ README.md
src
- This is the “source root” — where your source files live. Pages go here. Each page is a Markdown file. Observable Framework uses file-based routing, which means that the name of the file controls where the page is served. You can create as many pages as you like. Use folders to organize your pages.
src/index.md
- This is the home page for your app. You can have as many additional pages as you’d like, but you should always have a home page, too.
src/data
- You can put data loaders or static data files anywhere in your source root, but we recommend putting them here.
src/components
- You can put shared JavaScript modules anywhere in your source root, but we recommend putting them here. This helps you pull code out of Markdown files and into JavaScript modules, making it easier to reuse code across pages, write tests and run linters, and even share code with vanilla web applications.
observablehq.config.js
- This is the app configuration file, such as the pages and sections in the sidebar navigation, and the app’s title.
Command | Description |
---|---|
npm install |
Install or reinstall dependencies |
npm run dev |
Start local preview server |
npm run build |
Build your static site, generating ./dist |
npm run deploy |
Deploy your app to Observable |
npm run clean |
Clear the local data loader cache |
npm run observable |
Run commands like observable help |