https://github.com/yuriytkach/stream-16-demo-app
Demo application for online YouTube stream #16, #17, #20
https://github.com/yuriytkach/stream-16-demo-app
apache-poi aws-s3 demo-app docker java-mail sftp-client spring-boot testcontainers youtube-stream
Last synced: 4 months ago
JSON representation
Demo application for online YouTube stream #16, #17, #20
- Host: GitHub
- URL: https://github.com/yuriytkach/stream-16-demo-app
- Owner: yuriytkach
- License: mit
- Created: 2022-09-24T20:44:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-14T17:23:12.000Z (over 3 years ago)
- Last Synced: 2025-07-26T12:43:26.615Z (11 months ago)
- Topics: apache-poi, aws-s3, demo-app, docker, java-mail, sftp-client, spring-boot, testcontainers, youtube-stream
- Language: Java
- Homepage:
- Size: 330 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Demo Project for Online Stream #16,#17,#20, #21 - Microservice for Excel File Processing
Demo project for online stream #16 where a small microservice is created that processes Excel file
uploaded through REST API, saves file to AWS S3, parses it to JSON and send that to another service.
On stream #17 the dockerization of the project is done together with additional properties and settings
to prepare for running in production.
On stream #20 additional features are added: Sending of file to SFTP folder and then sending email.
The integration with all external services is tested with running services in containers.
On stream #21 monitoring was added to service with Prometheus and Grafana setup to see application metrics
## Access to Online Stream on YouTube
To get a link to online stream on YouTube please do the following:
- :moneybag: Make any donation to support my volunteering initiative to help Ukrainian Armed Forces by means described on [my website](https://www.yuriytkach.com/volunteer)
- :email: Write me an [email](mailto:me@yuriytkach.com) indicating donation amount and time
- :tv: I will reply with the link to the stream on YouTube.
Thank you in advance for your support! Слава Україні! :ukraine:
## Technologies
- Spring Boot
- Apache POI
- AWS Java SDK
- SSHJ for SFTP
- JavaMail
- Prometheus for monitoring
- TestContainers for testing
- GreenMail for testing mail server
### SFTP notes
To connect to SFTP server the SSH private key is used. The generated key is located in `src/test/resources`.
To generate new key you can use `ssh-keygen` tool on your system.
Note, that key would be generated in OPENSSH format.
To convert to PEM format use the following command:
```shell
ssh-keygen -p -m pem -f /path/to/file
```
## Building and Running the Application
To build the app, use gradle:
```shell
./gradlew build
```
To run application, use gradle:
```shell
./gradlew bootRun
```
After that you can access application on [http://localhost:8080](http://localhost:8080)
### Docker
To build docker image, use gradle:
```shell
./gradlew bootBuildImage
```
Then you run the docker container with exposing app port `8899`:
```shell
docker run -p 8899:8080 -t stream-16-demo-app:0.0.1-SNAPSHOT
```
After that you can access application on [http://localhost:8899](http://localhost:8899)
### Running docker-compose with external dependencies
Project includes the `docker-compose.yml` file where external services are defined together with application.
### Monitoring with Prometheus and Grafana
Prometheus and Grafana are started with docker-compose. Prometheus is set up to scape metrics from application
that is also running in docker. The configuration for prometheus is defined in `docker/prometheus.yml` file.
Grafana is set up to read metrics from Prometheus. Grafana is started with default configuration defined in
`docker/grafana.ini`. Default username and password to login to Grafana is `admin:admin`.
You can import dashboards that were created during online stream from json files:
- `docker/grafana-dashboard-online-stream.json`
- `docker/grafana-dashboard-spring-boot-stats.json`
## Documentation
### Reference Documentation
For further reference, please consider the following sections:
* [Official Gradle documentation](https://docs.gradle.org)
* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/2.7.4/gradle-plugin/reference/html/)
* [Create an OCI image](https://docs.spring.io/spring-boot/docs/2.7.4/gradle-plugin/reference/html/#build-image)
* [Spring Web](https://docs.spring.io/spring-boot/docs/2.7.4/reference/htmlsingle/#web)
* [Spring Boot Actuator](https://docs.spring.io/spring-boot/docs/2.7.4/reference/htmlsingle/#actuator)
* [Testcontainers](https://www.testcontainers.org/)
### Guides
The following guides illustrate how to use some features concretely:
* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
* [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/)
### Additional Links
These additional references should also help you:
* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle)