⚡ Energy Company Platform 🔋

Energy management system that connects customers with their energy consumption data and metering points.

📊 Overview

This platform provides customers with tools to monitor their energy usage, manage metering points, and see energy pricing information. The system consists of multiple microservices for scalability and maintainability.

🏗️ Architecture

Backend

• Java 21
• Spring Boot framework
• Spring Cloud Netflix for service discovery
• PostgreSQL databases
• Liquibase for database migrations
• JWT for secure authentication

Frontend

• React

• TypeScript

• Vite Modern build tool and development server

• Tailwind CSS for styling

• React Router for navigation

• React Hook Form for form handling

• Recharts for data visualization

• React Context API for global state management (AuthContext)

• React Hooks useState, useEffect, useContext for component state management

• Axios Promise-based HTTP client for API requests

  Testing

• Jest: Testing framework

• React Testing Library: For testing React components

• jest-dom: Custom matchers for DOM testing

🧩 Components

Backend Services

• api-gateway: Entry point for all client requests
• authentication-service: Handles user authentication and JWT token management
• common: Shared library with common utilities
• consumption-service: Manages energy consumption data and metering points
• customer-service: Handles customer information and user authentication and JWT token management
• elering-adapter: Integrates with Estfeed Elering for energy pricing data
• eureka-server: Service discovery for microservices

Frontend Components

• User authentication
• Dashboard with consumption overview
• Metering points management
• Energy price tracking

🖼️ Application Preview

Screenshot of the Energy Company dashboard showing consumption overview and metering points

🚀 Getting Started

Prerequisites

• Docker and Docker Compose
• Java 21 (for development)
• Node.js (for frontend development)

Running the Application ⚙️

The entire application can be started using Docker Compose:

docker-compose up --build

This will start all backend services, databases, and the frontend application.

Once the application is running:

• Frontend: Access the web application at http://localhost:5173/
• Backend APIs: Available through the API Gateway at http://localhost:4000/
• Eureka Dashboard: Monitor services at http://localhost:8761/

Demo Accounts 👤

The following demo accounts are available for testing:

Email	Password
alice@example.com	energycompany
bob@example.com	energycompany

💻 Development

Each microservice follows a modular structure:

• Service implementation
• Database migration application
• Liquibase changelog scripts

🚀 CI/CD Pipeline

This project includes a comprehensive GitHub Actions CI/CD pipeline for automatic deployment to AWS:

🔄 Workflows

• CI Workflow (ci.yml): Builds and tests all services on pull requests
• Development Deployment (deploy-dev.yml): Deploys to dev environment on PR updates
• Production Deployment (deploy-prod.yml): Deploys to production on merge to main

🏗️ Infrastructure

The pipeline deploys to AWS using:

• ECS Fargate for container orchestration
• ECR for container registry
• RDS PostgreSQL for databases
• Application Load Balancer for traffic routing
• CloudWatch for logging and monitoring

📋 Setup

1. Prerequisites: AWS account and configured GitHub secrets
2. Infrastructure: Deploy using CloudFormation template or run setup script
3. Deployment: Automatic on pull request and merge to main

For detailed setup instructions, see DEPLOYMENT.md

🎯 Deployment Strategy

Services are deployed in priority order:

1. Eureka Server - Service discovery
2. Database Migrations - Schema updates
3. Core Services - Business logic services
4. Authentication Service - Security layer
5. API Gateway - External entry point
6. Frontend Client - Web application