README.md

xCherry

Server and main repo of xCherry project

Documentation

See wiki.

How to use

As a coding framework, iWF provides three SDKs to use with:

• xCherry Golang SDK and samples
• xCherry Java SDK and samples
• xCherry Python SDK and samples
• xCherry Typescript SDK and samples

The xCherry SDKs/Samples require to run with the server by one of the below options:

Option 1: use example docker-compose of xCherry with a database

In this case you don't want to connect to your existing database:

• wget https://raw.githubusercontent.com/xcherryio/xcherry/main/docker-compose/docker-compose-postgres14-example.yaml && docker compose -f docker-compose-postgres14-example.yaml up -d
  • Will include a PostgresSQL database and some sample tables

Option 2: use docker-compose of xCherry to connect with your own database

• Install the database schema to your database
  • Postgres schema
• Run docker-compose file from this project:
  • docker-compose -f ./docker-compose/docker-compose.yaml up

Contribution

See contribution

Option 3: brew install

TODO: brew install xCherry binaries

Development Plan

See development plan

License

Apache 2.0. See license file