Updated 'how to run this repository locally'

This commit is contained in:
Bill Bittner 2017-06-18 10:07:14 -07:00 committed by GitHub
parent b6b1b0ab1d
commit 5dd62b1708

View file

@ -5,11 +5,18 @@ spee.ch is a single-serving site that reads and publishes images to and from the
* start lbry * start lbry
* install the [`lbry`](https://github.com/lbryio/lbry) daemon * install the [`lbry`](https://github.com/lbryio/lbry) daemon
* start the `lbry` daemon * start the `lbry` daemon
* start mysql
* install mysql
* create a database called `lbry`
* save your connection uri somewhere handy (you will need it when you start the server)
* the uri should be in the form `mysql://user:pass@host:port/dbname`
* clone this repo * clone this repo
* create a folder called `Uploads` in the same root directory where you cloned the repo * customize `config/develpment.json` by replacing the value of `Database.PublishUploadPath` with a string representing the local path where you want uploaded files to be stored.
* run `npm install` * run `npm install`
* from your terminal, run `npm start` * to start the server, from your command line run `node server.js` while passing three environmental variables: your lbry wallet address (`LBRY_WALLET_ADDRESS`), your mysql connection uri (`MYSQL_CONNECTION_STRING`), and the environment to run (`NODE_ENV`).
* to run hot, run `nodemon server.js` * i.e. `LBRY_WALLET_ADDRESS=<your wallet address here> MYSQL_CONNECTION_STRING=<your connection uri here> NODE_ENV=development node server.js`
* e.g. `LBRY_WALLET_ADDRESS=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX MYSQL_CONNECTION_STRING=mysql://root:XXXXXX@localhost:3306/lbry NODE_ENV=development node server.js`
* To run hot, use `nodemon` instead of `node`
* visit [localhost:3000](http://localhost:3000) * visit [localhost:3000](http://localhost:3000)
## site navigation ## site navigation