Update README.md

Update setup instructions link.
This commit is contained in:
Shawn K 2018-11-09 19:15:34 -05:00 committed by GitHub
parent de3faa663d
commit c405003231
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -5,45 +5,18 @@ You can create your own custom version of spee.ch by installing this code base a
## Quickstart ## Quickstart
### Ubuntu
[Ubuntu VPS Setup](./docs/ubuntu16vpspersonal.md)
_note: this is the quickstart guide, for an in-depth step-by-step overview visit the [fullstart guide](https://github.com/lbryio/spee.ch/blob/readme-update/fullstart.md)._ _note: this is the quickstart guide, for an in-depth step-by-step overview visit the [fullstart guide](https://github.com/lbryio/spee.ch/blob/readme-update/fullstart.md)._
#### Install System Dependencies: #### System Dependencies:
* [node](https://nodejs.org) * [node](https://nodejs.org)
* [MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html) * [MySQL](https://dev.mysql.com/doc/refman/8.0/en/installing.html)
* [`lbry`](https://github.com/lbryio/lbry) daemon * [`lbry`](https://github.com/lbryio/lbry) daemon
* note: retrieve an address from the daemon and send your wallet a few credits (or join us in the [#speech discord channel](https://discord.gg/YjYbwhS) and we will send you a few) * note: retrieve an address from the daemon and send your wallet a few credits (or join us in the [#speech discord channel](https://discord.gg/YjYbwhS) and we will send you a few)
* [FFmpeg](https://www.ffmpeg.org/download.html) * [FFmpeg](https://www.ffmpeg.org/download.html)
#### Clone this repo
```
$ git clone https://github.com/lbryio/spee.ch.git
```
#### Change directory into your project
```
$ cd spee.ch
```
#### Install node dependencies
```
$ npm install
```
#### Create the config files using the built-in CLI
```
$ npm run configure
```
#### Build & start the app
_note: make sure lbry is running in the background before proceeding_
```
$ npm run start
```
#### View in browser
* Visit [http://localhost:3000](http://localhost:3000) in your browser
#### Customize your app #### Customize your app
Check out the [customization guide](https://github.com/lbryio/spee.ch/blob/readme-update/customize.md) to change your app's appearance and components Check out the [customization guide](https://github.com/lbryio/spee.ch/blob/readme-update/customize.md) to change your app's appearance and components