Skip to content

A simple management system for Internet Service Providers.

License

Notifications You must be signed in to change notification settings

mairess/w-net-internet

Repository files navigation

W-net Internet

Context

This is an internet provider management system.

ER Diagram

Description of image

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

[email protected]

MAIL_PASSWORD=your-app-password

Steps:

  1. Clone repository:
git clone [email protected]:mairess/w-net-internet.git

cd w-net-internet
  1. Install dependencies:
mvn install -DskipTests
  1. Start ZooKeeper:
bin/zookeeper-server-start.sh config/zookeeper.properties
  1. Start Kafka:
bin/kafka-server-start.sh config/server.properties
  1. Start database:
docker compose up database -d --build 
  1. Run API:
mvn spring-boot:run
  1. Run tests:
mvn test
  1. 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

[email protected]

MAIL_PASSWORD=your-app-password

Steps:

  1. Clone repository:
git clone [email protected]:mairess/w-net-internet.git

cd w-net-internet
  1. Run API:
docker compose up -d --build 
  1. Run tests:
mvn test
  1. Access API documentation and available routes on your web browser at:
http://localhost:8080/swagger-ui/index.html