Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 3.52 KB

README.md

File metadata and controls

82 lines (61 loc) · 3.52 KB

Cardano Foundation | Ledger on the Blockchain

License: Apache 2.0 Conventional Commits GitHub release (with filter) Discord

Build Build with tests


The Ledger on the Blockchain (LOB) project aims to develop a solution that supports the adoption of Blockchain as a decentralised ledger, for digital recording and storing of accounting and financial information, by developing interface applications (APIs) that will execute the reading, conversion and validation of data across the different phases of the process.

For the project adopters, it will provide the opportunity to advance the use of the blockchain technology to share the organisation’s financial information in a secure, transparent, efficient and potentially low-cost way, at the same time that opens up new chances to improve, optimise and automate internal business processes.

Quickstart

Prerequisties:

  • Java 21
  • 100GB of disk space
  • 10GB of RAM

How to build

git clone [email protected]:cardano-foundation/cf-lob.git
cd cf-lob
cp cf-application/.env.template cf-application/.env
./gradlew clean build

Docker:

# start the containers and run the command
docker compose up --build -d
cp cf-application/.env.template cf-application/.env
docker exec -it app ./gradlew clean build

How to run locally

git clone [email protected]:cardano-foundation/cf-lob.git
cd cf-lob
export SPRING_CONFIG_LOCATIONS=classpath:/application.yml,classpath:/application-dev--yaci-dev-kit.yml
export SPRING_PROFILES_ACTIVE=dev--yaci-dev-kit
cp cf-application/.env.template cf-application/.env
./gradlew clean bootRun

Docker:

# start the containers and run the command
docker compose up --build -d
cp cf-application/.env.template cf-application/.env
docker exec -it app ./gradlew clean bootRun

Architecture

How to run automated tests

./gradlew clean test

Documentation

Link Audience
Code Of Conduct Developers
Contributing Developers
Security Developers