Skip to content

Commit

Permalink
formatted readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pranav-singhal committed Mar 13, 2018
1 parent 8d09101 commit 2b655d1
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Expand Up @@ -38,12 +38,29 @@ truffle unbox arvindkalra/express-box
3. In one terminal window run the Launch GanacheCLI `ganache-cli -i 666`
* To prevent creating a new network id everytime, we have set a default network key in the truffle config file.
* To change that, simply go to the 'truffle.js' file and change the network_id from '666' to " * " and to Launch GanacheCLI `ganache-cli`.
4. Run `npm install` or `yarn install` to install all the node modules
5. In another terminal window go the to project repositary, now, You need to compile the smart contracts written in the `/contracts` folder. For this, `truffle compile`
4. Install all the node modules required by running:
```javascript
// install all the node modules using npm
npm install
```
or if you prefer yarn
```javascript
//install all the node modules using yarn
yarn install
```
5. Open another terminal window in the project repository and compile all the smart contract(which can be found in the '/contracts' folder).
```
truffle compile
```

6. You can see that a new `/build` folder has been created in the root directory which contains the compiled contracts.
7. Now these contracts need to be deployed on the Blockchain. For this, `truffle migrate --network development`.

7. Now these contracts need to be deployed on the Blockchain. For this,
```
truffle migrate --network development
```
* If you changed the network_id to " * " in Step 1, you can run `truffle migrate`
8. To run the Express server `yarn start` or `npm server.js`, if you have nodemon installed.
8. To run the Express server `yarn start` or `npm server.js`
9. In the browser window open `http://localhost:3000/`.

**Collaborators**
Expand Down

0 comments on commit 2b655d1

Please sign in to comment.