Skip to content

Commit

Permalink
Updates to README.md Install instructions (steemit#1389)
Browse files Browse the repository at this point in the history
This PR updates and clarifies the condenser install instructions.

- Added step to verify NVM is installed.
- Changed config file from steem-example.json to default.json.
- Added quit/exit commands where appropriate.
- Added step to update ~/condenser/db/config/config.json with the mysql password.
- Clarified the step at the end to know when condenser is running.
- Updated the port number to be based on whatever is output as the port number condenser is running on.
  • Loading branch information
TimCliff authored and Valentine Zavgorodnev committed May 2, 2017
1 parent 3b12f27 commit cea98de
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ cd condenser
mkdir tmp
```

#### Verify NVM is installed

```bash
command -v nvm # verify
```

It should output "nvm". If it does not, install nvm.

#### Install dependencies

```bash
Expand All @@ -32,14 +40,15 @@ npm install -g babel-cli

```bash
cd config
cp steem-example.json steem-dev.json
cp default.json steem-dev.json
```

Generate a new crypto_key and save under server_session_secret in ./steem-dev.json.

```bash
node
> crypto.randomBytes(32).toString('base64')
> .exit
```

(note: it's steem.json in production)
Expand Down Expand Up @@ -78,6 +87,7 @@ Now launch mysql client and create steemit_dev database:
```bash
mysql -u root
> create database steemit_dev;
> quit
```

Install `sequelize-cli` globally:
Expand All @@ -86,6 +96,8 @@ Install `sequelize-cli` globally:
npm install -g sequelize sequelize-cli pm2 mysql
```

Edit `~/condenser/db/config/config.json` and save the mysql password under "password".

Run `sequelize db:migrate` in `db/` directory.

#### Install Tarantool
Expand Down Expand Up @@ -114,7 +126,7 @@ user@example:~$ tarantool
npm start
```

You now have your development front end running at localhost:3002, connected to the main public steem blockchain. You don't need to run ```steemd``` locally, by default you will connect to ```ws://node.steem.ws```. Use your regular account name and credentials to login -- there is no separate dev login.
It will take a few moments to launch. Once it says "Application started on port ####", you now have your development front end running at localhost:####, connected to the main public steem blockchain. You don't need to run ```steemd``` locally, by default you will connect to ```ws://node.steem.ws```. Use your regular account name and credentials to login -- there is no separate dev login.

#### Style Guides

Expand Down

0 comments on commit cea98de

Please sign in to comment.