blogchain

This application was generated using JHipster 5.8.2, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v5.8.2.

This is a simple web application to manage entities on a blockchain using an Hyperledger Fabric network v1.4.

When you create, update or delete entities using this sample "Blog" application, requests are sent to the Hyperledger network to update the blockchain ledger. For this to happen, Hyperledger must be running.

Hyperledger

To run this application you will need to run Hyperledger. See the readme in ./fabric-network/README.md to know how.

Generate the network

cd ./fabric-network/network/
./byfn.sh generate

Run the network

cd ./fabric-network/network/
./byfn.sh up

Show the logs

cd ./fabric-network/network/
docker-compose -f docker-compose-cli.yaml ps
docker-compose -f docker-compose-cli.yaml logs -f

Development

Before you can build this project, you must install and configure the following dependencies on your machine:

[Node.js][]: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

npm install

We use npm scripts and [Webpack][] as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.

./gradlew
npm start

Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies. Add the help flag on any command to see how you can use it. For example, npm help update.

The npm run command will list all of the scripts available to run for this project.

Building for production

To optimize the blogchain application for production, run:

./gradlew -Pprod clean bootWar

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar build/libs/*.war

Then navigate to http://localhost:8080 in your browser.

Refer to [Using JHipster in production][] for more details.

Testing

To launch your application's tests, run:

./gradlew test

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a postgresql database in a docker container, run:

docker-compose -f src/main/docker/postgresql.yml up -d

To stop it and remove the container, run:

docker-compose -f src/main/docker/postgresql.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

./gradlew bootWar -Pprod jibDockerBuild

Then run:

docker-compose -f src/main/docker/app.yml up -d