https://github.com/holepunchto/pear
combined Peer-to-Peer (P2P) Runtime, Development & Deployment tool
https://github.com/holepunchto/pear
desktop peer-to-peer runtime terminal
Last synced: about 2 months ago
JSON representation
combined Peer-to-Peer (P2P) Runtime, Development & Deployment tool
- Host: GitHub
- URL: https://github.com/holepunchto/pear
- Owner: holepunchto
- License: apache-2.0
- Created: 2024-02-03T08:52:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:53:21.000Z (6 months ago)
- Last Synced: 2024-10-29T12:37:32.193Z (6 months ago)
- Topics: desktop, peer-to-peer, runtime, terminal
- Language: JavaScript
- Homepage: https://docs.pears.com/
- Size: 1.88 MB
- Stars: 110
- Watchers: 24
- Forks: 11
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - Pears (⭐106) - Peer-to-peer runtime, development and deployment. (Recently Updated / [Oct 19, 2024](/content/2024/10/19/README.md))
- awesome-pears - Pear Source Code
- awesome-pears - Pear Source Code
README
# 🍐 Pear
## Getting Started
### Install:
```sh
npm install -g pear
```
### Help
```sh
pear help
```
```sh
pear --help
```
```sh
pear -h
```
## Documentation
[Documentation](https://docs.pears.com)
## Platform Development
Platform development is generally referred to as **localdev**.
**Clone:**
```sh
git clone https://github.com/holepunchto/pear && cd pear
```
**Install deps:**
```sh
npm install
```
Bootstrap the runtime binaries with
```sh
npm run bootstrap [KEY]
```
Key defaults to production key `npm run bootstrap` bootstraps from production runtimes.
First run will install runtimes in `by-arch`, create platform directory called `pear` and add a `pear.dev` symlink (Linux, Mac)or `pear.ps1` and `pear.cmd` files (Windows). These are system-specific and .gitignore'd.
Use `./pear.dev` (`\\pear.ps1` / `\\pear.cmd`) to execute the Pear Runtime directly in localdev.
## Drives
The following are public drives for the Production Pear.
### Runtimes Bootstrap
```
pear://gd4n8itmfs6x7tzioj6jtxexiu4x4ijiu3grxdjwkbtkczw5dwho
```
### Production Build
```
pear://pqbzjhqyonxprx8hghxexnmctw75mr91ewqw5dxe1zmntfyaddqy
```
### Stage Build
```
pear://17g37zzfo3dnmchf57ixw93gpxcncjmfyzybf4tjo99xi55ewf7o
```
Note: Always use the production build unless you are sure of what you are doing. The stage build may introduce untested breaking changes that could affect other Pear apps.
## License
Apache-2.0