DrugGuard Ghana Backend

A comprehensive Spring Boot backend application for the DrugGuard Ghana platform, providing drug verification, management, and analytics services for FDA Ghana.

🏥 Overview

DrugGuard Ghana Backend is a robust API service that enables:

Drug Verification: QR code scanning and authenticity verification
Drug Management: CRUD operations for FDA drug database
Analytics: Comprehensive reporting and insights
Voice Processing: Multi-language voice recognition and text-to-speech
User Management: Admin authentication and authorization
Reporting System: Citizen drug report management

🚀 Features

Core Features

✅ Drug Verification System - QR code scanning and authenticity checks
✅ Drug Management - Complete CRUD operations for drug database
✅ Analytics Dashboard - Comprehensive reporting and insights
✅ Voice Processing - Multi-language voice recognition and TTS
✅ User Authentication - JWT-based admin authentication
✅ Drug Reporting - Citizen report submission and management
✅ QR Code Generation - Dynamic QR code creation for drugs
✅ Search Functionality - Advanced drug search capabilities

Security Features

🔐 JWT-based authentication
🛡️ Role-based access control (FDA_ADMIN)
🔒 Secure password encryption (BCrypt)
🌐 CORS configuration
📝 Request/response logging

API Features

📊 RESTful API design
🔍 Advanced search capabilities
📱 Pagination support
🎯 Multi-language support (English, Twi, Ga, Ewe)
📈 Real-time analytics
🗂️ File upload support (QR codes, images)

🛠️ Technology Stack

Framework: Spring Boot 3.x
Language: Java 17+
Database: H2 (Development), MySQL/PostgreSQL (Production)
Security: Spring Security + JWT
Build Tool: Maven
API Documentation: OpenAPI/Swagger
Testing: JUnit 5, Mockito
Logging: SLF4J + Logback

📋 Prerequisites

Java 17 or higher
Maven 3.6+
Git
IDE (IntelliJ IDEA, Eclipse, VS Code)

🚀 Quick Start

1. Clone the Repository

git clone <repository-url>
cd ghana-backend

2. Configure Database

Edit src/main/resources/application.properties:

# Database Configuration
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password

# JPA Configuration
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.jpa.hibernate.ddl-auto=create-drop
spring.jpa.show-sql=true

# H2 Console (Development)
spring.h2.console.enabled=true
spring.h2.console.path=/h2-console

3. Build and Run

# Build the project
mvn clean install

# Run the application
mvn spring-boot:run

4. Access the Application

API Base URL: http://localhost:8080/api
H2 Console: http://localhost:8080/h2-console
Swagger UI: http://localhost:8080/swagger-ui.html

📚 API Documentation

Authentication Endpoints

Login

POST /api/auth/login
Content-Type: application/json

{
  "username": "admin",
  "password": "password"
}

Validate Token

GET /api/auth/validate
Authorization: Bearer <jwt-token>

Drug Management Endpoints

Get All Drugs

GET /api/admin/drugs?page=0&size=20&sortBy=name&sortDirection=asc
Authorization: Bearer <jwt-token>

Create Drug

POST /api/admin/drugs
Authorization: Bearer <jwt-token>
Content-Type: application/json

{
  "name": "Paracetamol 500mg",
  "manufacturer": "ABC Pharmaceuticals",
  "batchNumber": "BATCH001",
  "registrationNumber": "FDA123456",
  "activeIngredient": "Paracetamol",
  "strength": "500mg",
  "dosageForm": "Tablet",
  "category": "Analgesic",
  "manufactureDate": "2024-01-01",
  "expiryDate": "2026-01-01",
  "description": "Pain reliever and fever reducer"
}

Search Drugs

GET /api/drugs/search?query=paracetamol&page=0&size=20

Verify Drug

POST /api/drugs/verify
Content-Type: application/json

{
  "qrCode": "drug_123_abc123",
  "location": "Accra, Ghana"
}

Public Drug Search

GET /api/public/drugs/search?query=paracetamol&page=0&size=20

Voice Processing Endpoints

Voice Recognition

POST /api/voice/recognize
Content-Type: multipart/form-data

audio: <audio-file>
language: en

Text to Speech

POST /api/voice/speak
Content-Type: application/json

{
  "text": "Hello, this is a test message",
  "language": "en"
}

Get Available Languages

GET /api/voice/languages

Drug Reporting Endpoints

Submit Report

POST /api/reports
Content-Type: application/json

{
  "drugName": "Suspicious Drug",
  "manufacturer": "Unknown",
  "description": "Found suspicious packaging",
  "issueType": "COUNTERFEIT",
  "severity": "HIGH",
  "location": "Accra",
  "contactInfo": "[email protected]"
}

Get Recent Reports

GET /api/reports/recent

Analytics Endpoints

Overview Statistics

GET /api/admin/analytics/overview
Authorization: Bearer <jwt-token>

Drug Analytics

GET /api/admin/analytics/drugs
Authorization: Bearer <jwt-token>

Scan Analytics

GET /api/admin/analytics/scans?days=30
Authorization: Bearer <jwt-token>

🗂️ Project Structure

src/main/java/com/drugguard/ghana/
├── config/                 # Configuration classes
│   ├── DataInitializer.java
│   ├── DrugDataInitializer.java
│   └── WebSecurityConfig.java
├── controller/            # REST controllers
│   ├── AdminController.java
│   ├── AdminDrugController.java
│   ├── AnalyticsController.java
│   ├── AuthController.java
│   ├── DrugReportController.java
│   ├── HealthAiController.java
│   ├── PublicDrugController.java
│   ├── QrCodeController.java
│   ├── SearchController.java
│   └── VoiceController.java
├── dto/                  # Data Transfer Objects
│   ├── AdvancedSearchRequest.java
│   ├── CreateDrugReportRequest.java
│   ├── CreateDrugRequest.java
│   ├── DrugReportResponse.java
│   ├── DrugSearchRequest.java
│   ├── DrugVerificationResponse.java
│   ├── JwtResponse.java
│   ├── LoginRequest.java
│   ├── MessageResponse.java
│   ├── PublicDrugResponse.java
│   ├── QrCodeResponse.java
│   ├── SearchResponse.java
│   ├── SearchSuggestionsResponse.java
│   └── UpdateDrugRequest.java
├── model/                # Entity models
│   ├── Drug.java
│   ├── DrugReport.java
│   ├── FdaAdmin.java
│   └── ScanTracking.java
├── repository/           # Data access layer
│   ├── DrugReportRepository.java
│   ├── DrugRepository.java
│   ├── FdaAdminRepository.java
│   └── ScanTrackingRepository.java
├── security/            # Security configuration
│   ├── AuthTokenFilter.java
│   └── JwtUtils.java
├── service/             # Business logic
│   ├── AnalyticsService.java
│   ├── AuthService.java
│   ├── DrugReportService.java
│   ├── DrugService.java
│   ├── FdaAdminDetailsService.java
│   ├── HealthAiService.java
│   ├── QrCodeService.java
│   ├── ScanTrackingService.java
│   ├── SearchService.java
│   └── VoiceProcessingService.java
└── DrugguardGhanaBackendApplication.java

🔧 Configuration

Environment Variables

# Server Configuration
server.port=8080
server.servlet.context-path=/api

# Database Configuration
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=sa
spring.datasource.password=password

# JWT Configuration
jwt.secret=your-secret-key
jwt.expiration=86400000

# File Upload Configuration
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

# Logging Configuration
logging.level.com.drugguard=DEBUG
logging.level.org.springframework.security=DEBUG

Security Configuration

The application uses Spring Security with JWT authentication:

Public Endpoints: /api/public/**, /api/auth/**, /api/drugs/search/**, /api/voice/**
Admin Endpoints: /api/admin/** (requires FDA_ADMIN role)
Protected Endpoints: All other endpoints require authentication

🧪 Testing

Run Tests

# Run all tests
mvn test

# Run specific test class
mvn test -Dtest=DrugServiceTest

# Run with coverage
mvn test jacoco:report

Test Coverage

The project includes comprehensive tests for:

✅ Service layer tests
✅ Controller layer tests
✅ Repository layer tests
✅ Security configuration tests
✅ Integration tests

🚀 Deployment

Docker Deployment

# Build Docker image
docker build -t drugguard-ghana-backend .

# Run container
docker run -p 8080:8080 drugguard-ghana-backend

Production Configuration

For production deployment:

Database: Use MySQL or PostgreSQL
Security: Configure proper JWT secrets
Logging: Configure production logging levels
Monitoring: Add health checks and metrics
SSL: Configure HTTPS

📊 Monitoring & Health Checks

Health Endpoints

Health Check: GET /actuator/health
Info: GET /actuator/info
Metrics: GET /actuator/metrics

Logging

The application uses structured logging with different levels:

DEBUG: Detailed debugging information
INFO: General application information
WARN: Warning messages
ERROR: Error messages

🤝 Contributing

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Code Style

Follow Java coding conventions
Use meaningful variable and method names
Add proper documentation
Include unit tests for new features

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

For support and questions:

📧 Email: [email protected]
📱 Phone: +233 XX XXX XXXX
🌐 Website: https://drugguard-ghana.com

🙏 Acknowledgments

FDA Ghana for regulatory guidance
Spring Boot community for the excellent framework
All contributors and stakeholders

DrugGuard Ghana Backend - Empowering drug safety and verification in Ghana 🇬🇭

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
.mvn/wrapper		.mvn/wrapper
qr-codes		qr-codes
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
README.md		README.md
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml

Joeboy77/drug-guard_ghana-be

Folders and files

Latest commit

History

Repository files navigation