README.md

A Cardano datastore Java library using Yaci

Yaci Store is a modular Java library for developers who are keen on constructing their custom indexer solutions. Its architecture ensures that every component within Yaci Store is accessible both as a standalone Java library and a corresponding Spring Boot starter.

How to Run

Pre-requisites: Java 21

1. Download the latest binary and property file from release page
2. You need to download yaci-store-all-<version>.jar and application.properties files
3. Create a sub folder config and copy application.properties file to config directory
4. Edit application.properties file to configure your datasource and network details
5. Run java -jar yaci-store-all-<version>.jar from the directory where you have copied the jar file.

Build from source and Run

Pre-requisites: Java 21

Build

$> git clone https://github.com/bloxbean/yaci-store
$> cd yaci-store
$> ./gradlew clean build

Run

$> cd yaci-store
$> edit config/application.properties //datasource, network details
$> java -jar applications/all/build/libs/yaci-store-all-<version>.jar

Run Release Build (Jar or Docker)

To run a release build, follow the instructions in Getting Started - Out of Box Application

Documents

1. Overview

2. Design

3. Getting Started - Out of Box Application

4. Getting Started - Custom Application

Any questions, ideas or issues?

• Create a Github Discussion
• Create a Github Issue
• Discord Server

Support from YourKit

YourKit has generously granted the BloxBean projects an Open Source licence to use their excellent Java Profiler.

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor