Add readme

This commit is contained in:
Girish Ramakrishnan 2020-12-14 14:17:18 -08:00
parent bd03a63300
commit 66a181fff9

36
README.md Normal file
View file

@ -0,0 +1,36 @@
# PeerTube Cloudron App
This repository contains the Cloudron app package source for [PeerTube](https://joinpeertube.org/)
## Installation
[![Install](https://cloudron.io/img/button.svg)](https://cloudron.io/button.html?app=org.joinpeertube.cloudronapp)
or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
```
cloudron install --appstore-id org.joinpeertube.cloudronapp
```
## Building
The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
```
cd peertube-app
cloudron build
cloudron install
```
## Testing
The e2e tests are located in the `test/` folder and require [nodejs](http://nodejs.org/). They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the repos are still ok. The tests expect port 29418 to be available.
```
cd peertube-app/test
npm install
USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test.js
```