Skip to content
This repository has been archived by the owner. It is now read-only.
A decentralized ad server running on the blockchain
JavaScript Makefile HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
config
doc
e2e
src
webpack
.babelrc
.eslintrc
.fabricrc
.gitignore
.travis.yml
CustomGenesis.json-dist
LICENSE
README.md
babel-transformer.js
fabfile.py
makefile
package.json
webpack.config.babel.js

README.md

publication Archived Repository
The code of this repository was written to illustrate the blog post The Blockchain Explained to Web Developers, Part 2: In Practice
This code is not intended to be used in production, and is not maintained.

ZeroDollarHomePage

Install

Requirements:

# install npm dependencies and Selenium (for tests)
make install

Configuration

Github oAuth

You'll need to create a Github application at https://github.com/settings/developers then copy/paste the Client Id and Client Secret into your configuration file (development.js or production.js):

oauth: {
    githubClientId: 'Your Client ID',
    githubClientSecret: 'Your Client Secret',
},

Github API

For the application to have access to the Github API, you'll need to provide a way to authenticate with Github in the configuration file (development.js or production.js).

This can be:

  • A login/password to an account which can access the repositories on which you configured the hooks
  • An access token (Follow the instructions to create one) created from an account with access to the repositories on which you configured the hooks

Github hooks

You'll need to setup the Github hooks for the repositories you want to be watched by the application.

  • Go to your repository settings, Webhooks & services
  • Add a new webhook by entering [API_URL]:3420/github/callback in the Payload URL field (Port 3420 is important!)
  • Leave the secret field empty (verification is not implemented yet. PR are welcome !)
  • Select the Just the push event. option

That's it. Repeat for every repositories you want to bind.

### Ethereum

Create a file named .ethereum and put your default ethereum account address in it.

Starts a private ethereum network for development by running:

make start-ethereum

A miner must be running on this network to allow contracts deployment and blockchain operations through those contracts. Starts the miner by running:

make run-ethereum-miner

Deploying the contract is done by running:

make deploy-contracts-ethereum

Develop

# start servers (node and webpack via pm2)
make run-dev
# both servers will run in the background
# the Node server uses nodemon and will restart on code change
# the frontend is served by webpack dev server with hot reload

# you can restart either the api or the frontend by hand
make restart-api
make restart-frontend

Browse the app:

# stop servers (node and webpack)
make stop-dev

Note: for stability purposes, it's a good practice to not upgrade your project dependencies using major updates. It's why you should locally run npm set prefix='~' and not add dependencies prefixed with a carret ^ without good reason.

Test

# tests run in the "test" environment and don't empty the "development" database
make test

# alternately, you can run any of the individual test suites:
make test-api-unit
make test-api-functional
make test-frontend-unit
make test-frontend-functional
make test-isomorphic-unit
make test-ethereum

API (and common lib) unit tests using:

API functional tests using:

Frontend unit tests using:

Frontend fonctional tests using:

Deployment

See deployment instructions.

Managing servers with PM2

dev and tests servers are managed with PM2. So, It's possible to :

# display the 'front dev' server's logs
make log-frontend-dev
# display the 'api dev' server's logs
make log-api-dev

# display the list of all servers
make servers-list
# display the monitoring for all servers
make servers-monitoring
# stop all servers
make servers-stop-all
# stop all servers, delete them, and clear their logs.
make servers-clear-all
You can’t perform that action at this time.