🏢 ResourceHub Backend

Comprehensive resource management system built with Ballerina

A modular backend system for managing organizational resources including assets, meals, maintenance, users, and reporting with role-based access control and comprehensive analytics.

• Features
• Architecture
• Quick Start
• API Documentation
• Modules
• Configuration
• Development
• Deployment
• Contributing

• Asset Management - Complete asset lifecycle and allocation tracking
• User Management - Role-based user accounts and authentication
• Meal Services - Comprehensive meal planning and request system
• Maintenance - Facility maintenance request and tracking system
• Notifications - Real-time notification system for pending requests
• Organizations - Multi-tenant organization management
• Dashboard Analytics - Real-time system monitoring and reporting

• JWT Authentication - Secure token-based authentication
• Role-Based Access Control - Admin, SuperAdmin, User, Manager roles
• CORS Support - Cross-origin resource sharing configuration
• Data Privacy - Secure data handling and user privacy protection

• Automated Reports - Scheduled PDF report generation
• Email Distribution - Automatic report delivery
• Multi-Module Analytics - Comprehensive system insights
• Real-time Dashboards - Live system metrics and KPIs

graph TB
A[Frontend Applications] --> B[ResourceHub Backend]
B --> C[Authentication Module]
B --> D[Asset Module]
B --> E[User Module]
B --> F[Meal Module]
B --> G[Maintenance Module]
B --> H[Dashboard Module]
B --> I[Notification Module]
B --> J[Report Module]
B --> K[Organization Module]
B --> L[Common Module]
C --> M[Database Module]
D --> M
E --> M
F --> M
G --> M
H --> M
I --> M
J --> M
K --> M
L --> M
M --> N[MySQL Database]
J --> O[Report Service :9091]
H --> P[Dashboard Service :9092]
I --> Q[Notification Service :9093]
C --> R[Auth Service :9094]
M --> S[Main Services :9090]

• Independent Modules - Each feature as a separate module
• Shared Dependencies - Common utilities and database access
• Scalable Architecture - Easy to extend and maintain
• RESTful APIs - Standard HTTP REST endpoints

• Ballerina 2201.8.x or later
• MySQL 8.0 or later
• Java 17 or later

git clone https://github.com/FiveStackDev/Resource_Hub-Backend-.git
cd Resource_Hub-Backend-/Ballerina

-- Create databaseCREATEDATABASEresourcehub;
-- Run SQL scripts
mysql -u username -p resourcehub < resources/sql/create_tables.sql
mysql -u username -p resourcehub < resources/sql/add_accounts.sql
mysql -u username -p resourcehub < resources/sql/add_assets.sql

Create Config.toml file:

[resourcehub]
USER = "your_db_user"PASSWORD = "your_db_password"HOST = "localhost"PORT = 3306DATABASE = "resourcehub"SMTP_HOST = "smtp.gmail.com"SMTP_USER = "your_email@gmail.com"SMTP_PASSWORD = "your_app_password"PDFSHIFT_API_KEY = "your_pdfshift_api_key"

bal run

The services will be available at:

• Main Services:http://localhost:9090
• Report Services:http://localhost:9091
• Dashboard Services:http://localhost:9092
• Notification Services:http://localhost:9093
• Auth Services:http://localhost:9094

All protected endpoints require JWT token in the Authorization header:

Authorization: Bearer <your-jwt-token>

• 👤 User - Basic access to own data and resources
• 🛡️ Admin - Administrative access to most system functions
• 🚀 SuperAdmin - Full system access and configuration
• 📋 Manager - Enhanced user access with some admin capabilities

[resourcehub]
USER = "username"# Database usernamePASSWORD = "password"# Database password HOST = "localhost"# Database hostPORT = 3306# Database portDATABASE = "resourcehub"# Database name

SMTP_HOST = "smtp.gmail.com"# SMTP serverSMTP_USER = "email@domain.com"# Email usernameSMTP_PASSWORD = "app_password"# Email password

PDFSHIFT_API_KEY = "your_api_key"# PDF generation service

Place SSL certificates in resources/certificates/:

• certificate.crt - Public certificate
• certificate.key - Private key
• certificate.csr - Certificate signing request

# Build the project
bal build
# Run with hot reload
bal run --observability-included
# Generate documentation
bal doc
# Run tests
bal test

ResourceHub-Backend/
├── 📄 Ballerina.toml # Project configuration
├── 📄 Config.toml # Runtime configuration
├── 📄 Dependencies.toml # Dependency management
├── 📄 main.bal # Application entry point
├── 📁 modules/ # Feature modules
│ ├── 📁 asset/ # Asset management
│ ├── 📁 auth/ # Authentication
│ ├── 📁 user/ # User management
│ ├── 📁 meal/ # Meal services
│ ├── 📁 maintenance/ # Maintenance system
│ ├── 📁 notification/ # Notification system
│ ├── 📁 dashboard/ # Analytics dashboard
│ ├── 📁 organizations/ # Organization management
│ ├── 📁 report/ # Report generation
│ ├── 📁 database/ # Database connectivity
│ └── 📁 common/ # Shared utilities
├── 📁 resources/ # Static resources
│ ├── 📁 certificates/ # SSL certificates
│ └── 📁 sql/ # Database scripts
└── 📁 target/ # Build artifacts

1. Create new module in modules/ directory
2. Define service endpoints and data models
3. Implement business logic
4. Add authentication and authorization
5. Update main.bal to include new service
6. Write comprehensive tests
7. Update documentation

FROM ballerina/ballerina:2201.8.0
COPY . /app
WORKDIR /app
RUN bal build
CMD ["bal", "run", "target/bin/ResourceHub.jar"]
EXPOSE 9090 9091 9092 9093 9094

1. Environment Variables

   export RESOURCEHUB_USER="prod_user"export RESOURCEHUB_PASSWORD="secure_password"export RESOURCEHUB_HOST="db.production.com"

2. SSL Configuration

   • Use production SSL certificates
   • Configure HTTPS listeners
   • Enable security headers

3. Database

   • Use production MySQL instance
   • Configure connection pooling
   • Set up database backups

4. Monitoring

   • Enable Ballerina observability
   • Configure logging levels
   • Set up health checks

1. Fork the repository
2. Create a feature branch
3. Follow coding standards
4. Write comprehensive tests
5. Update documentation
6. Submit a pull request

• Follow Ballerina best practices
• Use meaningful variable names
• Write comprehensive comments
• Include error handling
• Maintain consistent formatting

# Run all tests
bal test# Run specific module tests
bal test modules/asset
# Generate test coverage
bal test --code-coverage

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

FiveStackDev - Development Team

• GitHub: @FiveStackDev

• Minul Chathumal - @Minulck
• Theekshana Udara - @th33k
• Piumini Tishani - @PiuminiTishani
• Nethminiwelgama - @nethminiwelgama
• Sineth Nimhan - @SinethNimhan

For support and questions:

• 📧 Email: resourcehub.contact.info@gmail.com
• 📚 Documentation: Project Wiki
• 🐛 Issues: GitHub Issues