Update README.md

This commit is contained in:
Bill Bittner 2018-03-08 09:41:22 -08:00 committed by GitHub
parent 059684e0b0
commit 7f1fbae366
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,7 +1,7 @@
# Spee.ch
Spee.ch is a web app that reads and publishes images and videos to and from the [LBRY](https://lbry.io/) blockchain.
## how to run this repository locally
## How to run this repository locally
* start mysql
* install mysql
* create a database called `lbry`
@ -9,8 +9,6 @@ Spee.ch is a web app that reads and publishes images and videos to and from the
* start lbrynet daemon
* install the [`lbry`](https://github.com/lbryio/lbry) daemon
* start the `lbry` daemon
* start spee.ch-sync
* install and run this [`speech-sync`](https://github.com/billbitt/spee.ch-sync) tool
* start spee.ch
* clone this repo
* run `npm install`
@ -20,6 +18,9 @@ Spee.ch is a web app that reads and publishes images and videos to and from the
* build the app by running `npm run build-prod`
* to start the server, run `npm run start`
* visit [localhost:3000](http://localhost:3000)
* start spee.ch-sync (optional, recommended)
* Note: this tool will decode blocks from the `lbry` blockchain and update the Claim and Certificate tables in mysql with all the claims from the blockchain. This is not necessary if you only want to host and resolve content published through your version of spee.ch, but it is required if you want to retrieve and host other content from the lbry network.
* install and run this [`speech-sync`](https://github.com/billbitt/spee.ch-sync) tool
## Tests
* Spee.ch uses `mocha` with `chai` for testing.
@ -54,5 +55,5 @@ Spee.ch is a web app that reads and publishes images and videos to and from the
* `channelName`(optional)
* `channelPassword` (optional,; required if `channelName` is provided)
## bugs
## Bugs
If you find a bug or experience a problem, please report your issue here on github and find us in the lbry discord!