Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rgomezcasas authored Nov 28, 2024
1 parent 53bca37 commit d176e85
Showing 1 changed file with 23 additions and 66 deletions.
89 changes: 23 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,23 @@
# ✨ spark-kafka_rabbitmq_sqs-course

[![License](https://img.shields.io/github/license/com.codely/spark-kafka_rabbitmq_sqs-course?style=flat-square)](/LICENSE)

[![GitHub Repo stars](https://img.shields.io/github/stars/com.codely/spark-kafka_rabbitmq_sqs-course?style=flat-square)](https://github.com/com.codely/spark-kafka_rabbitmq_sqs-course/stargazers)

[![Continuous Integration status](https://img.shields.io/github/actions/workflow/status/com.codely/spark-kafka_rabbitmq_sqs-course/ci.yml?style=flat-square)](https://github.com/com.codely/spark-kafka_rabbitmq_sqs-course/actions/workflows/ci.yml)

## 🚀 Environment setup

You only need the common tooling used for developing Scala applications:

- [JDK](https://www.oracle.com/java/technologies/downloads/)
- [SBT](https://www.scala-sbt.org/download)

<details>
<summary>Installing instructions for macOS with SDKMAN!</summary>

If you use macOS, we would recommend using SDKMAN! to manage different JDK versions and tooling:

1. [Install SDKMAN with homebrew](https://github.com/sdkman/homebrew-tap?tab=readme-ov-file#installation)
2. Install the JDK you prefer. If you ask us, we will opt for:
1. [Check the latest Java LTS JDK version](https://endoflife.date/oracle-jdk)
2. Check the latest Zulu distribution version for that LTS with:
```shell
sdk list java
```
3. Install it:
```shell
sdk install java XX.YY.ZZ-zulu
```
3. Install the latest SBT:
```shell
sdk install sbt
```
</details>

## ✅ Tests

Just run:

```shell
sbt test
```

There is also the `sbt t` alias 😊

## 🤽‍ Pre-push Git hook

There's one Git hook included. It's inside the `doc/hooks` folder, and it will run the `prep` SBT task before pushing to any remote.

This `prep` task is intended to run all the checks you consider before pushing.
At this very moment, it tries to compile and check the code style rules with ScalaFmt.

You can define what this task does by modifying the `prep` task in the `build.sbt` file.
We like the approach of just having to run 1 single SBT task instead of multiple tasks because it's more efficient (the hook doesn't have to create multiple SBT sessions), and also because this way we can control the pre push tasks with the SBT alias defined at the `build.sbt` without altering the hooks.

If you want to install this hook, just `cd doc/hooks` and run `./install-hooks.sh`.

## ⚖️ License

See [`LICENSE`](LICENSE).

## 🤔 About

Project developed by [com.codely, Inc.](https://com.codely) and bootstrapped with the [Codely Scala Spark Skeleton (powered by Giter 8)](https://github.com/CodelyTV/scala-spark-skeleton.g8).
<p align="center">
<a href="https://codely.com">
<img src="https://user-images.githubusercontent.com/10558907/170513882-a09eee57-7765-4ca4-b2dd-3c2e061fdad0.png" width="300px" height="92px" alt="Codely logo"/>
</a>
</p>

<h1 align="center">
🐰 Spark: Integration with Kafka, RabbitMQ and AWS SQS
</h1>

<p align="center">
<a href="https://github.com/CodelyTV"><img src="https://img.shields.io/badge/Codely-OS-green.svg?style=flat-square" alt="Codely Open Source projects"/></a>
<a href="https://pro.codely.com"><img src="https://img.shields.io/badge/Codely-Pro-black.svg?style=flat-square" alt="Codely Pro courses"/></a>
</p>

<p align="center">
Learn Apache Spark from scratch with a practical approach
</p>

<p align="center">
<a href="https://github.com/CodelyTV/spark_for_devs-course/stargazers">Stars are welcome 😊</a><br><br>
Course (Spanish): <a href="https://pro.codely.com/library/spark-integracion-con-kafka-rabbitmq-y-aws-sqs-230966">Spark: Integración con Kafka, RabbitMQ y AWS SQS</a>
</p>

0 comments on commit d176e85

Please sign in to comment.