mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-17 14:34:19 +01:00
Updating guides (1.5.0) (#154)
* Remove `--` for app option passthrough Changed since `paparam` was used for parsing command line options: 85892a6a32a84ae42a548f8e3ac0b5dbedd70c80 Now uses `cmd.rest` for app args. * Use `Pear.config.args` for howto scripts * Update "starting a pear desktop project" guide to match template * Remove `--no-ask-trust` flag from `pear run` cli doc This command was replaced by `--no-ask` which was already in the documentation. Updated a reference to `--no-ask-trust` in the 'Sharing a Pear Application' guide. * Fix typos in "Releasing a Pear Application" guide * Correct application storage folder name in hyperbee howto * Add missing `test/index.test.js` in project structure for terminal guide * Remove language about app continuing to run This is no longer true at least as of pear: v0.5114.pqbzjhqyonxprx8hghxexnmctw75mr91ewqw5dxe1zmntfyaddqy / v1.5.0 * Fix extra indention in example code for hypercore howto * Format json in `_template.json` example * Add instructions to set up a minimal `package.json` for testing template Without this, the next step of `pear run --dev .` does not work since `pear` expects a `package.json` file. * Rename hyperbee reader app in hyperdrive howto to avoid name conflict Naming only matters if someone is following the guides and starts each guide from the same root directory. If they do, then `bee-reader-app` from the hyperdrive conflicts with the `bee-reader-app` from the hyperbee howto. * Remove unrelated youtube tutorial from hyperswarm howto * Update guide/creating-a-pear-init-template.md Co-authored-by: David Mark Clements <huperekchunow@googlemail.com> * Fix spelling mistake Co-authored-by: David Mark Clements <huperekchunow@googlemail.com> --------- Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
This commit is contained in:
@@ -149,12 +149,12 @@ Open the `bee-reader-app` and pass it the core key:
|
||||
|
||||
```
|
||||
cd bee-reader-app
|
||||
pear run --dev . -- <SUPPLY KEY HERE>
|
||||
pear run --dev . <SUPPLY KEY HERE>
|
||||
```
|
||||
|
||||
Query the database by entering a key to lookup into the `bee-reader-app` terminal and hitting return.
|
||||
|
||||
Each application has dedicated storage at `Pear.config.storage`. Try logging out `Pear.config.storage` for the `bee-reader-app` and then look at the disk space for that storage path after each query. Notice that it's significantly smaller than `writer-storage`! This is because Hyperbee only downloads the Hypercore blocks it needs to satisfy each query, a feature we call **sparse downloading.**
|
||||
Each application has dedicated storage at `Pear.config.storage`. Try logging out `Pear.config.storage` for the `bee-reader-app` and then look at the disk space for that storage path after each query. Notice that it's significantly smaller than `bee-writer-app`! This is because Hyperbee only downloads the Hypercore blocks it needs to satisfy each query, a feature we call **sparse downloading.**
|
||||
|
||||
Importantly, a Hyperbee is **just** a Hypercore, where the tree nodes are stored as Hypercore blocks.
|
||||
|
||||
@@ -164,7 +164,7 @@ Finally create a `core-reader-app` project:
|
||||
mkdir core-reader-app
|
||||
cd core-reader-app
|
||||
pear init -y -t terminal
|
||||
npm install corestore hyperswarm hyperbee b4a bare-process
|
||||
npm install corestore hyperswarm hyperbee b4a
|
||||
```
|
||||
|
||||
|
||||
@@ -174,10 +174,12 @@ Alter the generated `core-reader-app/index.js` file to the following
|
||||
import Hyperswarm from 'hyperswarm'
|
||||
import Corestore from 'corestore'
|
||||
import b4a from 'b4a'
|
||||
import process from 'bare-process'
|
||||
|
||||
import { Node } from 'hyperbee/lib/messages.js'
|
||||
|
||||
const key = Pear.config.args[0]
|
||||
if (!key) throw new Error('provide a key')
|
||||
|
||||
// creation of a corestore instance
|
||||
const store = new Corestore('./reader-storage')
|
||||
|
||||
@@ -188,7 +190,7 @@ Pear.teardown(() => swarm.destroy())
|
||||
swarm.on('connection', conn => store.replicate(conn))
|
||||
|
||||
// create or get the hypercore using the public key supplied as command-line argument
|
||||
const core = store.get({ key: b4a.from(process.argv[3], 'hex') })
|
||||
const core = store.get({ key: b4a.from(key, 'hex') })
|
||||
// wait till the properties of the hypercore instance are initialized
|
||||
await core.ready()
|
||||
|
||||
@@ -212,7 +214,7 @@ Open the `core-reader-app` with `pear run --dev .`, passing the core key to it:
|
||||
|
||||
```
|
||||
cd core-reader-app
|
||||
pear run --dev . -- <SUPPLY KEY HERE>
|
||||
pear run --dev . <SUPPLY KEY HERE>
|
||||
```
|
||||
|
||||
Now we can examine the Hyperbee as if it were just a Hypercore.
|
||||
|
||||
Reference in New Issue
Block a user