Skip to content

Commit d176e85

Browse files
authored
docs: add readme
1 parent 53bca37 commit d176e85

File tree

1 file changed

+23
-66
lines changed

1 file changed

+23
-66
lines changed

README.md

Lines changed: 23 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,23 @@
1-
# ✨ spark-kafka_rabbitmq_sqs-course
2-
3-
[![License](https://img.shields.io/github/license/com.codely/spark-kafka_rabbitmq_sqs-course?style=flat-square)](/LICENSE)
4-
5-
[![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)
6-
7-
[![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)
8-
9-
## 🚀 Environment setup
10-
11-
You only need the common tooling used for developing Scala applications:
12-
13-
- [JDK](https://www.oracle.com/java/technologies/downloads/)
14-
- [SBT](https://www.scala-sbt.org/download)
15-
16-
<details>
17-
<summary>Installing instructions for macOS with SDKMAN!</summary>
18-
19-
If you use macOS, we would recommend using SDKMAN! to manage different JDK versions and tooling:
20-
21-
1. [Install SDKMAN with homebrew](https://github.com/sdkman/homebrew-tap?tab=readme-ov-file#installation)
22-
2. Install the JDK you prefer. If you ask us, we will opt for:
23-
1. [Check the latest Java LTS JDK version](https://endoflife.date/oracle-jdk)
24-
2. Check the latest Zulu distribution version for that LTS with:
25-
```shell
26-
sdk list java
27-
```
28-
3. Install it:
29-
```shell
30-
sdk install java XX.YY.ZZ-zulu
31-
```
32-
3. Install the latest SBT:
33-
```shell
34-
sdk install sbt
35-
```
36-
</details>
37-
38-
## ✅ Tests
39-
40-
Just run:
41-
42-
```shell
43-
sbt test
44-
```
45-
46-
There is also the `sbt t` alias 😊
47-
48-
## 🤽‍ Pre-push Git hook
49-
50-
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.
51-
52-
This `prep` task is intended to run all the checks you consider before pushing.
53-
At this very moment, it tries to compile and check the code style rules with ScalaFmt.
54-
55-
You can define what this task does by modifying the `prep` task in the `build.sbt` file.
56-
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.
57-
58-
If you want to install this hook, just `cd doc/hooks` and run `./install-hooks.sh`.
59-
60-
## ⚖️ License
61-
62-
See [`LICENSE`](LICENSE).
63-
64-
## 🤔 About
65-
66-
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).
1+
<p align="center">
2+
<a href="https://codely.com">
3+
<img src="https://user-images.githubusercontent.com/10558907/170513882-a09eee57-7765-4ca4-b2dd-3c2e061fdad0.png" width="300px" height="92px" alt="Codely logo"/>
4+
</a>
5+
</p>
6+
7+
<h1 align="center">
8+
🐰 Spark: Integration with Kafka, RabbitMQ and AWS SQS
9+
</h1>
10+
11+
<p align="center">
12+
<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>
13+
<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>
14+
</p>
15+
16+
<p align="center">
17+
Learn Apache Spark from scratch with a practical approach
18+
</p>
19+
20+
<p align="center">
21+
<a href="https://github.com/CodelyTV/spark_for_devs-course/stargazers">Stars are welcome 😊</a><br><br>
22+
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>
23+
</p>

0 commit comments

Comments
 (0)