forked from LengKundee/MQL5-Google-Onedrive
149 lines
4.8 KiB
Markdown
149 lines
4.8 KiB
Markdown
# Boat-House Integration Summary
|
|
|
|
## Overview
|
|
|
|
Successfully integrated the boat-house microservices restaurant management system from [VitaminC0224/boat-house](https://github.com/VitaminC0224/boat-house) into the MQL5-Google-Onedrive project.
|
|
|
|
## Integration Date
|
|
|
|
2026-02-10
|
|
|
|
## What Was Integrated
|
|
|
|
### Boat-House System
|
|
- **Type**: Microservices-based restaurant management system
|
|
- **Size**: 157MB (15,665 files)
|
|
- **Architecture**: Spring Boot (Java), Node.js, .NET Core
|
|
- **Databases**: MySQL, PostgreSQL, Redis
|
|
- **Source**: https://github.com/VitaminC0224/boat-house
|
|
|
|
### Services Included
|
|
1. **client** - Customer-facing restaurant website
|
|
2. **management** - Backend management dashboard
|
|
3. **statistics-service** - Statistics and analytics (Node.js + .NET + Redis + PostgreSQL)
|
|
4. **product-service** - Product and menu management (Spring Boot + MySQL)
|
|
5. **account-service** - User account management (Spring Boot + MySQL)
|
|
6. **order-service** - Order processing
|
|
7. **pay-service** - Payment processing
|
|
|
|
### DevOps Tools
|
|
- Jenkins pipelines for CI/CD
|
|
- JMeter for performance testing
|
|
- Selenium for UI automation
|
|
- Kompose for Kubernetes deployment
|
|
- Docker Compose for orchestration
|
|
|
|
## Changes Made
|
|
|
|
### 1. Repository Structure
|
|
```
|
|
boat-house/ # Complete microservices system
|
|
├── client/ # Customer website
|
|
├── management/ # Admin dashboard
|
|
├── statistics-service/ # Stats service
|
|
├── product-service/ # Product service
|
|
├── account-service/ # Account service
|
|
├── order-service/ # Order service
|
|
├── pay-service/ # Payment service
|
|
├── jmeter/ # Performance tests
|
|
├── selenium/ # UI tests
|
|
├── pipelines/ # CI/CD scripts
|
|
├── kompose/ # Kubernetes configs
|
|
├── docker-compose.yml # Orchestration
|
|
└── README.md # Original docs
|
|
```
|
|
|
|
### 2. Documentation Created
|
|
- `docs/Boat_House_Integration.md` - Comprehensive integration guide
|
|
- `docs/Boat_House_Quick_Start.md` - Quick start guide with Docker instructions
|
|
- Updated `README.md` with boat-house reference
|
|
- Updated `docs/INDEX.md` with integration documentation link
|
|
|
|
### 3. Build Configuration
|
|
- Updated `.gitignore` to exclude boat-house build artifacts:
|
|
- `node_modules/`
|
|
- `target/`
|
|
- `.gradle/`
|
|
- `build/`
|
|
- `*.jar`, `*.war`
|
|
- `dist/`
|
|
|
|
### 4. Validation Scripts
|
|
- Created `scripts/validate_boat_house.py` - Integration validation script
|
|
- Updated `scripts/ci_validate_repo.py` - Excluded boat-house from secret scanning
|
|
|
|
## Validation Results
|
|
|
|
All checks passing:
|
|
- ✅ Repository structure validated (11/11 checks)
|
|
- ✅ CI validation script passing
|
|
- ✅ Code review completed with no issues
|
|
- ✅ No conflicts with existing MT5 trading system
|
|
|
|
## How to Use
|
|
|
|
### Quick Start with Docker
|
|
```bash
|
|
cd boat-house
|
|
docker-compose up -d
|
|
```
|
|
|
|
Access the applications at:
|
|
- Customer Website: http://localhost:5000
|
|
- Management Dashboard: http://localhost:5001
|
|
- Statistics API: http://localhost:6001
|
|
- Product API: http://localhost:7001
|
|
- Account API: http://localhost:7002
|
|
|
|
### Documentation
|
|
- [Integration Guide](Boat_House_Integration.md) - Full documentation
|
|
- [Quick Start Guide](Boat_House_Quick_Start.md) - Getting started
|
|
- [Original README](../boat-house/README.md) - Boat-house documentation
|
|
|
|
## Architecture Notes
|
|
|
|
### Independence
|
|
Both systems in this repository are independent:
|
|
- **MT5 Trading System**: `mt5/`, `scripts/`, `config/`
|
|
- **Boat-House System**: `boat-house/`
|
|
|
|
They can be used separately or together without interference.
|
|
|
|
### Port Mappings
|
|
- 3306: MySQL (Product/Account services)
|
|
- 5000: Client website
|
|
- 5001: Management dashboard
|
|
- 6001: Statistics API
|
|
- 6379: Redis
|
|
- 7001: Product API
|
|
- 7002: Account API
|
|
|
|
## License
|
|
|
|
The boat-house project retains its original license. See [boat-house/LICENSE](../boat-house/LICENSE).
|
|
|
|
## Source Attribution
|
|
|
|
- Original Repository: https://github.com/VitaminC0224/boat-house
|
|
- Integrated By: A6-9V/MQL5-Google-Onedrive
|
|
- Integration Date: February 10, 2026
|
|
|
|
## Security Notes
|
|
|
|
The boat-house directory contains demo/example API keys in JavaScript files. These are:
|
|
- Placeholder keys from the FullCalendar library
|
|
- Clearly marked as non-production keys
|
|
- Excluded from secret scanning in CI/CD
|
|
|
|
## Support
|
|
|
|
For issues specific to:
|
|
- **Boat-House functionality**: Refer to the [original repository](https://github.com/VitaminC0224/boat-house)
|
|
- **Integration into this project**: Open an issue in this repository
|
|
|
|
## Next Steps
|
|
|
|
1. Review the [Integration Guide](Boat_House_Integration.md)
|
|
2. Follow the [Quick Start Guide](Boat_House_Quick_Start.md) to run the system
|
|
3. Explore individual service documentation in their respective directories
|
|
4. Customize configurations as needed for your environment
|