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

Docker

Apache kafka

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:

git clone git@github.com:mairess/w-net-internet.git

cd w-net-internet

2. Install dependencies:

mvn install -DskipTests

3. Start ZooKeeper:

bin/zookeeper-server-start.sh config/zookeeper.properties

4. Start Kafka:

bin/kafka-server-start.sh config/server.properties

5. Start database:

docker compose up database -d --build 

6. Run API:

mvn spring-boot:run

7. Run tests:

mvn test

8. Access API documentation and available routes on your web browser at:

http://localhost:8080/swagger-ui/index.html

Run with Docker

Prerequisites

Make sure you have the following installed on your machine:

Docker

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:

git clone git@github.com:mairess/w-net-internet.git

cd w-net-internet

2. Run API:

docker compose up -d --build 

3. Run tests:

mvn test

4. Access API documentation and available routes on your web browser at:

http://localhost:8080/swagger-ui/index.html