https://github.com/mairess/w-net-internet
A simple management system for Internet Service Providers.
https://github.com/mairess/w-net-internet
docker jacoco java junit kafak spring-boot spring-data spring-doc-openapi spring-security test-containers
Last synced: about 1 month ago
JSON representation
A simple management system for Internet Service Providers.
- Host: GitHub
- URL: https://github.com/mairess/w-net-internet
- Owner: mairess
- License: mit
- Created: 2024-06-28T19:21:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T15:13:51.000Z (almost 2 years ago)
- Last Synced: 2025-10-07T07:38:10.837Z (8 months ago)
- Topics: docker, jacoco, java, junit, kafak, spring-boot, spring-data, spring-doc-openapi, spring-security, test-containers
- Language: Java
- Homepage:
- Size: 572 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# W-net Internet
## Context
This is an internet provider management system.
# ER Diagram
## Run locally
To run this project locally, follow these steps:
### Prerequisites
Make sure you have the following installed on your machine:
[Java](https://www.oracle.com/java/)
[Docker](https://www.docker.com/get-started/)
[Apache kafka](https://kafka.apache.org/documentation/#quickstart)
Also, set up the following env variables for the mail service:
```
MAIL_HOST=smtp.domainExample.com
MAIL_PORT=your-port-number-like 000
MAIL_USERNAME=myMail@domainExample.com
MAIL_PASSWORD=your-app-password
```
### Steps:
1. Clone repository:
```BASH
git clone git@github.com:mairess/w-net-internet.git
cd w-net-internet
```
2. Install dependencies:
```BASH
mvn install -DskipTests
```
3. Start ZooKeeper:
```BASH
bin/zookeeper-server-start.sh config/zookeeper.properties
```
4. Start Kafka:
```BASH
bin/kafka-server-start.sh config/server.properties
```
5. Start database:
```BASH
docker compose up database -d --build
```
6. Run API:
```BASH
mvn spring-boot:run
```
7. Run tests:
```BASH
mvn test
```
8. Access API documentation and available routes on your web browser at:
```BASH
http://localhost:8080/swagger-ui/index.html
```
## Run with Docker
### Prerequisites
Make sure you have the following installed on your machine:
[Docker](https://www.docker.com/get-started/)
Also, set up the following env variables for the mail service:
```
MAIL_HOST=smtp.domainExample.com
MAIL_PORT=your-port-number-like 000
MAIL_USERNAME=myMail@domainExample.com
MAIL_PASSWORD=your-app-password
```
### Steps:
1. Clone repository:
```BASH
git clone git@github.com:mairess/w-net-internet.git
cd w-net-internet
```
2. Run API:
```BASH
docker compose up -d --build
```
3. Run tests:
```BASH
mvn test
```
4. Access API documentation and available routes on your web browser at:
```BASH
http://localhost:8080/swagger-ui/index.html
```