diff --git a/README.md b/README.md index c27480ef..21030052 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,18 @@ spee.ch is a single-serving site that reads and publishes images to and from the * start lbry * install the [`lbry`](https://github.com/lbryio/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 -* 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` -* from your terminal, run `npm start` - * to run hot, run `nodemon server.js` +* 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`). + * i.e. `LBRY_WALLET_ADDRESS= MYSQL_CONNECTION_STRING= 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) ## site navigation