Set up asciidoc based documentation.

Patch by Jon Haddad; Reviewed by Dinesh Joshi for CASSANDRASC-15
7 files changed
tree: 0d632bb17db8d6b7209bed16df1e22ec7e8cd259
  1. .circleci/
  2. docs/
  3. gradle/
  4. ide/
  5. src/
  6. .gitignore
  7. api.yaml
  8. build.gradle
  9. CHANGES.txt
  10. checkstyle.xml
  11. gradle.properties
  12. gradlew
  13. gradlew.bat
  14. LICENSE.txt
  15. README.md
  16. settings.gradle
README.md

Apache Cassandra Sidecar [WIP]

This is a Sidecar for the highly scalable Apache Cassandra database. For more information, see the Apache Cassandra web site and CIP-1.

This is project is still WIP.

Requirements

  1. Java >= 1.8 (OpenJDK or Oracle), or Java 11
  2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.

Getting started

After you clone the git repo, you can use the gradle wrapper to build and run the project. Make sure you have Apache Cassandra running on the host & port specified in conf/sidecar.yaml.

$ ./gradlew run

You can use build, test to build & test the project.

CircleCI Testing

You will need to use the “Add Projects” function of CircleCI to set up CircleCI on your fork. When promoted to create a branch, do not replace the CircleCI config, choose the option to do it manually. CircleCI will pick up the in project configuration.

Wondering where to go from here?