https://github.com/simonstnn/bemed
Helping government institutions manage their environmental footprint
https://github.com/simonstnn/bemed
rest-api sql typescript vue
Last synced: 8 months ago
JSON representation
Helping government institutions manage their environmental footprint
- Host: GitHub
- URL: https://github.com/simonstnn/bemed
- Owner: SimonStnn
- Created: 2025-02-21T13:48:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-20T18:01:13.000Z (11 months ago)
- Last Synced: 2025-05-20T19:29:34.559Z (11 months ago)
- Topics: rest-api, sql, typescript, vue
- Language: Vue
- Homepage:
- Size: 14.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BEMED - Zero Waste Management System
BEMED is a comprehensive solution designed to help institutions assess and improve their waste management practices. The system provides tools for waste treatment assessments, product usage tracking, and discovering environmentally friendly alternatives to single-use products.
## Features
- **Waste Management Assessment**: Interactive surveys to evaluate current waste management practices
- **Product Usage Tracking**: Monitor consumption of single-use products
- **Alternative Products**: Discover and compare environmentally friendly alternatives
- **Environmental Impact Metrics**: Track the environmental footprint reduction through improved practices
- **Authentication & Authorization**: Secure user management through Keycloak integration
- **Responsive Interface**: Mobile-friendly design that works across devices
## Architecture
BEMED follows a microservice architecture approach, utilizing Docker containers orchestrated via Docker Compose:
- **Frontend**: Vue.js 3 application with Vuetify for UI components
- **Backend**: Node.js REST API built with Express
- **Authentication**: Keycloak for identity and access management
- **Database**: MariaDB for data storage
- **Reverse Proxy**: Traefik for routing and load balancing
- **Administration Tools**: Portainer for container management and PHPMyAdmin for database administration
```mermaid
architecture-beta
group cloud(cloud)[Cloud]
group frontend(server)[Frontend]
service web(server)[Web app] in frontend
group backend(server)[Backend Server]
group docker(disk)[Docker] in backend
service db(database)[MySQL] in docker
service keycloak(server)[Keycloak] in docker
service api(server)[Backend API] in docker
service webserver(server)[Frontend Webserver] in docker
service traefik(server)[Traefik] in docker
service portainer(server)[Portainer] in docker
service phpmyadmin(server)[PhpMyAdmin] in docker
junction dbjunction in docker
web:R <--> L:traefik
traefik:R <--> L:api
traefik:T <--> L:keycloak
api:R <--> L:db
db:T <-- B:dbjunction
phpmyadmin:B <-- T:dbjunction
keycloak:R <-- L:dbjunction
traefik:B <--> T:webserver
```
## Getting Started
### Prerequisites
- Docker and Docker Compose
- Node.js 18+ (for local development)
- A modern web browser
### Installation
1. Clone the repository:
```bash
git clone https://github.com/SimonStnn/BEMED.git
cd BEMED
```
2. Create a `.env` file in the root directory with the following configuration:
```conf
# Domain configuration
BEMED_DOMAIN=localhost
DNS_PREFIX_KEYCLOAK=keycloak
DNS_PREFIX_BEMED_BACKEND=api
DNS_PREFIX_BEMED_FRONTEND=app
BEMED_PROTOCOL=http
NODE_ENV=development
# API configuration
BEMED_API_PORT=3000
# Database configuration
MARIADB_ROOT_PASSWORD=your_secure_password
# Keycloak configuration
KC_BOOTSTRAP_ADMIN_USERNAME=admin
KC_BOOTSTRAP_ADMIN_PASSWORD=strong_password
KC_DB_USERNAME=keycloak
KC_DB_PASSWORD=keycloak_db_password
KC_DB_NAME=keycloak
# Client configuration
KEYCLOAK_REALM=BEMED
KEYCLOAK_BACKEND_CLIENT_ID=backend
KEYCLOAK_FRONTEND_CLIENT_ID=frontend
KEYCLOAK_CLIENT_SECRET=your_client_secret
```
3. Start the application using Docker Compose:
```bash
docker-compose up -d
```
4. Access the application at
### Development Setup
For development work:
1. Install backend dependencies:
```bash
cd backend
npm install
```
2. Install frontend dependencies:
```bash
cd frontend
npm install
```
3. Run backend in development mode:
```bash
cd backend
npm run dev
```
4. Run frontend in development mode:
```bash
cd frontend
npm run dev
```
## Accessing Services
After deployment, the following services are available:
- **Frontend**:
- **Backend API**:
- **API Documentation**:
- **Documentation**:
- **Keycloak Admin**:
- **PHPMyAdmin**:
- **Portainer**:
- **Traefik Dashboard**:
## Documentation
Comprehensive documentation is available at after deployment, including:
- **Getting Started Guide**: For system administrators
- **Backend API Documentation**: Details on available API endpoints
- **Frontend Documentation**: Information about the user interface
- **Docker Services Documentation**: Configuration details for each service