mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-17 06:24:24 +01:00
terminal doc stubs
This commit is contained in:
@@ -6,7 +6,7 @@ Pear by Holepunch is a combined Peer-to-Peer (P2P) Runtime, Development & Deploy
|
||||
|
||||
Pear makes it possible to build, share and extend P2P applications using common Web and Mobile technology.
|
||||
|
||||
Herein is everything needed to create unstoppable, zero-infrastructure P2P applications for Desktop, Terminal (soon) & Mobile (soon).
|
||||
Herein is everything needed to create unstoppable, zero-infrastructure P2P applications for Desktop, Terminal & Mobile (soon).
|
||||
|
||||
Welcome to the Internet of Peers
|
||||
_– Holepunch, the P2P Company_
|
||||
@@ -16,8 +16,10 @@ Welcome to the Internet of Peers
|
||||
### Guide
|
||||
|
||||
* [Getting Started](./guide/getting-started.md)
|
||||
* [Starting a Pear Project](./guide/starting-a-pear-project.md)
|
||||
* [Making a Pear Application](./guide/making-a-pear-app.md)
|
||||
* [Starting a Pear Desktop Project](./guide/starting-a-pear-desktop-project.md)
|
||||
* [Making a Pear Desktop Application](./guide/making-a-pear-desktop-app.md)
|
||||
* [Starting a Pear Terminal Project](./guide/starting-a-pear-terminal-project.md)
|
||||
* [Making a Pear Terminal Application](./guide/making-a-pear-terminal-app.md)
|
||||
* [Sharing a Pear Application](./guide/sharing-a-pear-app.md)
|
||||
* [Releasing a Pear Application](./guide/releasing-a-pear-app.md)
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Making a Pear Application
|
||||
# Making a Pear Desktop Application
|
||||
|
||||
## Step 1. Install modules
|
||||
|
||||
17
guide/making-a-pear-terminal-app.md
Normal file
17
guide/making-a-pear-terminal-app.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Making a Pear Terminal Application
|
||||
|
||||
## Step 1. Install modules
|
||||
|
||||
This app uses these modules: `hyperswarm`, `hypercore-crypto`, and `b4a`.
|
||||
|
||||
```
|
||||
$ npm i hyperswarm hypercore-crypto b4a
|
||||
```
|
||||
|
||||
**Note**: If the modules are installed while the app is running an error is thrown similar to `Cannot find package 'hyperswarm' imported from /app.js`. When installing modules, close down the app, before they can be installed.
|
||||
|
||||
- [hyperswarm](https://www.npmjs.com/package/hyperswarm). One of the main building blocks. Find peers that share a "topic".
|
||||
- [hypercore-crypto](https://www.npmjs.com/package/hypercore-crypto). A set of crypto function used in Pear.
|
||||
- [b4a](https://www.npmjs.com/package/b4a). A set of functions for bridging the gap between the Node.js `Buffer` class and the `Uint8Array` class.
|
||||
|
||||
## Step 2.
|
||||
18
guide/starting-a-pear-terminal-project.md
Normal file
18
guide/starting-a-pear-terminal-project.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Starting a Pear Terminal Project
|
||||
|
||||
## Step 1. Init
|
||||
|
||||
First create a new project using `pear init`.
|
||||
|
||||
```
|
||||
$ mkdir chat-bot
|
||||
$ cd chat-bot
|
||||
$ pear init --yes
|
||||
```
|
||||
|
||||
This will create a base structure for the project.
|
||||
|
||||
- `package.json`. Configuration for the app. Notice the `pear` property.
|
||||
- `index.js`. The entrpoint for the app.
|
||||
- `app.js`. The main code.
|
||||
- `test/index.test.js`. Skeleton for writing tests.
|
||||
Reference in New Issue
Block a user