Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/khadkarajesh/blockchain-feed

Blockchain application built on Ethereum
https://github.com/khadkarajesh/blockchain-feed

chai ethereum ethereum-contract ganache truffle-framework

Last synced: 9 days ago
JSON representation

Blockchain application built on Ethereum

Awesome Lists containing this project

README

        

# Twitter Feed
Twitter clone application which consists following features
- Listing of tweets
- Creation of tweet
- Deletion of tweet
- Insertation of tweet

## Built With

Chai
Lite-server
Solc
Truffle
Truffle-contract

### Docker commands

- Run `docker-compose -p cz-test -f docker-compose.tests.yml up` to run all tests
- Run `docker-compose -p cz-migrate -f docker-compose.migrate.yml up` to deploy to Ropsten

Deployment will require you to have a `.env` file with the following content:

```
ENFURA_KEY = "YourInfuraApiKey"
MNEMONIC_KEY = "your mnemonic provided by metamask"
```

---

### Npm commands

This may require additional global npm installations, but here's an indication of what should make the project work locally:

- `npm install -g truffle && npm install -g ganache-cli`
- `npm install`

---

Then to run tests, first run a server in one terminal:

- `ganache-cli`

And run the tests in another terminal:

- `npm run test`

To have a coverage of your tests, run:

- `npm run coverage` (This command is not yet containerized)

To migrate to ropsten, run:

- `npm run migrate`

To run the test or the migration through Docker:

- `npm run docker:test`
- `npm run docker:migrate`

---

### Truffle commands

Most of npm commands are shorthands for truffle commands. Here are the original Truffle commands:

- Run tests (do not forget to have a server running in another terminal): `truffle test`
- Run tests with coverage report: `truffle run coverage`

To deploy the smart contracts:

- `truffle compile`
- `truffle migrate --network ropsten` (you may also replace `ropsten` by the network of your choice)