Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattakvshi/near-backend
My project NEAR is a platform for providing notification to the public about emergency situations. This is my training project, at the moment it consists of 5 microservices, not counting copies of the workers. Technologies such as Java, Spring Boot, Rest API, gRPC, Kafka, PostgreSQL, Redis, Docker, Kubernetes and others are used.
https://github.com/mattakvshi/near-backend
docker grpc hibernate java kafka microservice postgresql redis rest-api spring-boot telegram-bot
Last synced: 12 days ago
JSON representation
My project NEAR is a platform for providing notification to the public about emergency situations. This is my training project, at the moment it consists of 5 microservices, not counting copies of the workers. Technologies such as Java, Spring Boot, Rest API, gRPC, Kafka, PostgreSQL, Redis, Docker, Kubernetes and others are used.
- Host: GitHub
- URL: https://github.com/mattakvshi/near-backend
- Owner: mattakvshi
- Created: 2023-10-11T16:36:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-10T08:07:02.000Z (2 months ago)
- Last Synced: 2024-09-11T10:39:53.836Z (2 months ago)
- Topics: docker, grpc, hibernate, java, kafka, microservice, postgresql, redis, rest-api, spring-boot, telegram-bot
- Language: Java
- Homepage: https://mattakvshi.github.io/NEAR-frontend/
- Size: 318 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NEAR-backend
## Used stack
- Java
- Spring
- PostgreSQL
- MongoDB
- Redis
- Apache Kafka
- Doker
- Kubernetes
- Nginx
# Implemented services:
The architecture is built according to the Citadel pattern:
- [NEAR API](https://github.com/mattakvshi/NEAR-backend/tree/main/NEAR%20API) - The main service that contains all the endpoints and is responsible for interacting with the client software. This service processes all user information, works with the main database and transmits the necessary data to Kafka when sending notifications.
- [TelegeramWorker](https://github.com/mattakvshi/NEAR-backend/tree/main/TelegramWorker) - The worker service for sending notifications via telegram.
- [EmailWorker](https://github.com/mattakvshi/NEAR-backend/tree/main/EmailWorker) - The worker service for sending notifications via mail.
- [MobilePushWorker](https://github.com/mattakvshi/NEAR-backend/tree/main/MobilePushWorker) - The worker service for sending notifications via push notification.
- [gRPC-gateway](https://github.com/mattakvshi/NEAR-backend/tree/main/grpc-gateway) - A service for connecting the tg bot and the main API.
# More info
More information can be found in README.md a repository with a [frontend](https://github.com/mattakvshi/NEAR-frontend).
# Getting Started
### Reference Documentation
For further reference, please consider the following sections:
- [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
- [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/3.3.1/maven-plugin/reference/html/)
- [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.3.1/maven-plugin/reference/html/#build-image)
- [Spring Boot DevTools](https://docs.spring.io/spring-boot/docs/3.3.1/reference/htmlsingle/index.html#using.devtools)
- [Spring Web](https://docs.spring.io/spring-boot/docs/3.3.1/reference/htmlsingle/index.html#web)
- [Spring Security](https://docs.spring.io/spring-boot/docs/3.3.1/reference/htmlsingle/index.html#web.security)
- [Spring Data JPA](https://docs.spring.io/spring-boot/docs/3.3.1/reference/htmlsingle/index.html#data.sql.jpa-and-spring-data)
### 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/)
- [Securing a Web Application](https://spring.io/guides/gs/securing-web/)
- [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/)
- [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/)
- [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
### Maven Parent overrides
Due to Maven's design, elements are inherited from the parent POM to the project POM.
While most of the inheritance is fine, it also inherits unwanted elements like `` and `` from the parent.
To prevent this, the project POM contains empty overrides for these elements.
If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.