getting started

This commit is contained in:
David Mark Clements
2023-11-27 14:53:46 +01:00
parent ff859c513e
commit 33c88c9535
2 changed files with 64 additions and 1 deletions

View File

@@ -1 +1,17 @@
# pears_com-docs # Pear by Holepunch
> Pear loads applications remotely from peers and allows anyone to create and share applications with peers.
Pear by Holepunch is a combined Peer-to-Peer (P2P) Runtime, Development & Deployment tool.
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 & Mobile.
Welcome to the Internet of Peers
  _ Holepunch, the P2P Company_
## Table of Contents
* [Getting Started](./getting-started.md)
* [Making a Pear App](./making-a-pear-app.md)

47
getting-started.md Normal file
View File

@@ -0,0 +1,47 @@
# Getting Started with Pear
## Requirements
Pear runs on Windows, Mac and Linux.
The `pear` CLI can be installed from [npm](https://www.npmjs.com/), which comes with [`node`](https://nodejs.org/en/about).
The `npm` package manager can also be used to install application dependencies later on.
On MacOS and Linux, we recommend installing `node` using [`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating)
On Windows we recommend installing `node` with [`nvs`](https://github.com/jasongin/nvs#setup).
> Info: The Pear Runtime does not rely on `node`, `node` is only needed to install and run the `npm` package manager.
## Setup
To install Pear run the following command:
```sh
npm i -g pear
```
To complete the setup, run the `pear` command.
```
pear
```
If a Pear application, such as [Keet](https://keet.io) is already installed on a machine then the Pear
platform is already available. In this case, running `pear` should show the pear help output.
If not, the first run of `pear` will fetch the platform from peers, after which running `pear` again should output help information.
To check that Pear is fully working, try the following command:
```
pear launch keet
```
Pear loads applications from peers, so this command should launch [Keet](https://keet.io) whether or not it was downloaded and installed beforehand.
## Next
* [Making a Pear App](./making-a-pear-app.md)