{"id":15056830,"url":"https://github.com/reljicd/spring-boot-cassandra","last_synced_at":"2025-04-10T04:36:05.502Z","repository":{"id":94100538,"uuid":"125875358","full_name":"reljicd/spring-boot-cassandra","owner":"reljicd","description":"Spring Boot + Apache Cassandra example app","archived":false,"fork":false,"pushed_at":"2018-03-21T11:04:59.000Z","size":31,"stargazers_count":10,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T05:51:44.887Z","etag":null,"topics":["apache-cassandra","bash","bash-script","cassandra","cassandra-cql","cql","docker","docker-compose","dockerfile","java","java-8","junit","maven","pom","shell","shell-script","spring-boot","spring-data-cassandra","spring-test"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reljicd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-19T14:58:04.000Z","updated_at":"2025-02-06T04:53:57.000Z","dependencies_parsed_at":"2023-03-05T09:00:17.114Z","dependency_job_id":null,"html_url":"https://github.com/reljicd/spring-boot-cassandra","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reljicd%2Fspring-boot-cassandra","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reljicd%2Fspring-boot-cassandra/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reljicd%2Fspring-boot-cassandra/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reljicd%2Fspring-boot-cassandra/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reljicd","download_url":"https://codeload.github.com/reljicd/spring-boot-cassandra/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248158723,"owners_count":21057189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache-cassandra","bash","bash-script","cassandra","cassandra-cql","cql","docker","docker-compose","dockerfile","java","java-8","junit","maven","pom","shell","shell-script","spring-boot","spring-data-cassandra","spring-test"],"created_at":"2024-09-24T21:56:45.361Z","updated_at":"2025-04-10T04:36:05.496Z","avatar_url":"https://github.com/reljicd.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring Boot + Apache Cassandra\n\nThis is an example **Spring Boot + Apache Cassandra** app.\n\nIt was made using **Spring Boot**, **Apache Cassandra**, **Spring Security**, **Spring Data Cassandra**, **Docker** and **Docker Compose**.\n\n##Configuration\n\nIf you are not using localhost Cassandra, it is necessary to configure it to use proper endpoints.\n\n### Configuration files\n\nFolder **src/resources/** contains config files for **spring-boot-cassandra** Spring Boot application.\n\n* **src/resources/application.properties** - main configuration file\n\n### Environment variables\n\nConfiguration using environment variables is done using next variables:\n\n* **SPRING_DATA_CASSANDRA_CONTACT_POINTS** - Cassandra cluster endpoints\n\n* **SPRING_DATA_CASSANDRA_KEYSPACE_NAME** - Cassandra keyspace\n\nExample:\n\n```bash\n$ export SPRING_DATA_CASSANDRA_CONTACT_POINTS=cassandra_contact_point1,cassandra_contact_point2\n$ export SPRING_DATA_CASSANDRA_KEYSPACE_NAME=cassandra_keyspace_name\n```\n\n### Command line arguments\n\nIt is also possible to pass these configuration settings using command line arguments. Example:\n\n```bash\n$ java -Djava.security.egd=file:/dev/./urandom -jar app.jar \\\n    --spring.data.cassandra.contact-points=assandra_contact_point1,cassandra_contact_point2 \\\n    --spring.data.cassandra.keyspace-name=keyspace-name\n``` \n\n## How to run\n\n### Maven\n\nopen a terminal and run the following commands to ensure that you have valid versions of Java and Maven installed:\n\n```bash\n$ java -version\njava version \"1.8.0_102\"\nJava(TM) SE Runtime Environment (build 1.8.0_102-b14)\nJava HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)\n```\n\n```bash\n$ mvn -v\nApache Maven 3.3.9 (bb52d8502b132ec0a5a3f4c09453c07478323dc5; 2015-11-10T16:41:47+00:00)\nMaven home: /usr/local/Cellar/maven/3.3.9/libexec\nJava version: 1.8.0_102, vendor: Oracle Corporation\n```\n\n#### Using the Maven Plugin\n\nThe Spring Boot Maven plugin includes a run goal that can be used to quickly compile and run your application. \nApplications run in an exploded form, as they do in your IDE. \nThe following example shows a typical Maven command to run a Spring Boot application:\n \n```bash\n$ mvn spring-boot:run\n``` \n\n#### Using Executable Jar\n\nTo create an executable jar run:\n\n```bash\n$ mvn package\n``` \n\nTo run that application, use the java -jar command, as follows:\n\n```bash\n$ java -jar target/spring-boot-cassandra-0.0.1-SNAPSHOT.jar\n```\n\nTo exit the application, press **ctrl-c**.\n\n### Docker\n\nIt is possible to run **spring-boot-cassandra** and **Cassandra** using Docker:\n\n#### spring-boot-cassandra\n\nBuild Docker image:\n```bash\n$ mvn package\n$ docker build -t spring-boot-cassandra:dev -f docker/spring-boot-cassandra/Dockerfile .\n```\n\nRun Docker container:\n```bash\n$ docker run --rm -i -p 9003:9003 \\\n      -e SPRING_DATA_CASSANDRA_CONTACT_POINTS=$SPRING_DATA_CASSANDRA_CONTACT_POINTS \\\n      -e SPRING_DATA_CASSANDRA_KEYSPACE_NAME=$SPRING_DATA_CASSANDRA_KEYSPACE_NAME \\\n      --name spring-boot-cassandra \\\n      spring-boot-cassandra:dev\n```\n\n##### Helper script\n\nIt is possible to run all of the above with helper script:\n\n```bash\n$ chmod +x scripts/run_docker.sh\n$ scripts/run_docker.sh\n```\n\n#### Cassandra\n\nBuild Docker image:\n```bash\n$ docker build -t cassandra:dev -f docker/cassandra/Dockerfile .\n```\n\nRun Docker container:\n```bash\n$ docker run --rm -i \\\n      -p 9042:9042 \\\n      --name cassandra \\\n      cassandra:dev\n```\n\n##### Helper script\n\nIt is possible to run all of the above with helper script:\n\n```bash\n$ chmod +x scripts/run_docker_cassandra.sh\n$ scripts/run_docker_cassandra.sh\n```\n\n### Docker Compose\n\nDocker Compose file **docker/docker-compose.yml** is written to facilitate running of both properly initialized Cassandra, \nas well of the spring-boot-cassandra containers.\n\nRun Docker Compose:\n```bash\n$ mvn package\n$ docker-compose -f docker/docker-compose.yml up --build --force-recreate --abort-on-container-exit\n```\n\n#### Helper script\n\nIt is possible to run all of the above with helper script:\n\n```bash\n$ chmod +x scripts/run_docker_compose.sh\n$ scripts/run_docker_compose.sh\n```\n\n## Docker \n\nFolder **docker/spring-boot-cassandra** contains Dockerfile for:\n\n* **docker/spring-boot-cassandra/Dockerfile** - Docker build file for executing spring-boot-cassandra Docker image. \nInstructions to build artifacts, copy build artifacts to docker image and then run microservice on proper port with proper configuration file.\n\n* **docker/spring-boot-cassandra/wait-for-it.sh** - is a pure bash script that will wait on the availability of a host and TCP port. It is useful for synchronizing the spin-up of interdependent services, such as linked docker containers. Since it is a pure bash script, it does not have any external dependencies. https://github.com/vishnubob/wait-for-it \n\nFolder **docker/cassandra** contains:\n\n* **docker/cassandra/Dockerfile** - Docker build file for Cassandra Docker image. \n\n* **docker/cassandra/docker-entrypoint.sh** - Entrypoint shell script for running Cassandra and executing CQL files after Cassandra is initialized. https://github.com/dschroe/cassandra-docker\n\n* **docker/cassandra/initial-seed.cql** - Schema definition and imports for Cassandra. \n\n## Util Scripts\n\n* **scripts/run_docker.sh.sh** - util script for running spring-boot-cassandra Docker container using **docker/spring-boot-cassandra/Dockerfile**\n\n* **scripts/run_docker_cassandra.sh** - util script for running Cassandra Docker container using **docker/cassandra/Dockerfile**\n\n* **scripts/run_docker_compose.sh** - util script for running Docker Compose.\n\n## Tests\n\nTests can be run by executing following command from the root of the project:\n\n```bash\n$ mvn test\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freljicd%2Fspring-boot-cassandra","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freljicd%2Fspring-boot-cassandra","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freljicd%2Fspring-boot-cassandra/lists"}