add script for local dev

Author: bechirboujelbene

.gitignore

@@ -177,7 +177,6 @@ __pycache__/
 
 # C extensions
 *.so
-*.sh
 # Distribution / packaging
 */bin/*
 .Python

README.md

@@ -16,9 +16,30 @@ A platform to connect people for outdoor sports, featuring smart matching (GenAI
 
 ---
 
+## Requirements
+
+### Functional Requirements
+- Users can register and log in using Auth0 authentication.
+- Users can create, view, and update their profiles, including uploading an avatar.
+- The system matches users based on sport interests, bio, and skill level using a GenAI-powered engine.
+- Users can view a list of suggested matches and send/receive messages in real time.
+- Location data is used to suggest nearby matches.
+- All user, location, and matching data is persisted in a PostgreSQL database.
+- Admins can monitor system health and metrics via Grafana and Prometheus dashboards.
+
+
+
+### User Stories / Use Cases
+- As a new user, I want to quickly register and set up my profile so I can start finding sports partners.
+- As a user, I want to see a list of people who share my sports interests and live nearby.
+- As a user, I want to chat with my matches in real time.
+- As an admin, I want to monitor the health of all services from a central dashboard.
+
+
+
 ## Overview
 
-The core functionality of the application is to connect individuals with shared interests in outdoor sports and physical activities. Users create profiles, specify their preferred sports and availability, and discover potential partners or groups in their area. The platform offers recommendations, matching, and communication tools to reduce the time and effort required to find activity partners.
+The core functionality of the application is to connect individuals with shared interests in outdoor sports and physical activities. Users create profiles, share their bio, specify their preferred sports and skill level, and discover potential partners or groups in their area. The platform offers recommendations, matching, and communication tools to reduce the time and effort required to find activity partners.
 
 ### Intended Users
 - Amateur outdoor sport enthusiasts
@@ -45,10 +66,13 @@ The system is built as a set of microservices:
 | client             | React + NGINX          | 3000 | Frontend web app                         |
 | user-service       | Spring Boot (Java)     | 8080 | User profiles, auth, matching            |
 | location-service   | Spring Boot (Java)     | 8081 | Location data, geospatial logic          |
+| matching-service   | Spring Boot (Java)     | 8083 | Match history persistence, ranking, API  |
 | genai              | FastAPI (Python)       | 8000 | AI/LLM matching, embeddings              |
 | messaging-service  | Spring Boot (Java)     | 8082 | Messaging, WebSocket                     |
 | api-gateway        | NGINX + Lua            | 80   | API gateway, JWT, CORS, proxy            |
 | db                 | PostgreSQL             | 5432 | Data storage                             |
+| grafana            | Grafana                | 3001 | Monitoring dashboard                     |
+| prometheus         | Prometheus             | 9090 | Metrics collection and monitoring         |
 
 ---
 
@@ -62,24 +86,29 @@ The system is built as a set of microservices:
 ```bash
 git clone https://github.com/AET-DevOps25/team-evil-jenkins.git
 cd team-evil-jenkins
-cp .env.example .env 
-docker compose up --build
+cp .env.example .env
+./build-all.sh
 ```
 - Access frontend: http://localhost:3000
 
+The `build-all.sh` script will automatically:
+- Build the frontend (client)
+- Build all backend Java services
+- Start Docker Compose with all services
+
+You only need to run this script after a fresh clone or when dependencies change.
 
 ---
 
 ## Kubernetes & Cloud Deployment
 
 **Kubernetes (Helm):**
 - Prerequisites: `kubectl`, `helm`, AWS CLI (for cloud)
-- Edit `helm/team-evil-jenkins/values.yaml` for your environment.
 - Deploy:
   ```bash
   helm upgrade --install team-evil-jenkins ./helm/team-evil-jenkins -n team-evil-jenkins
   ```
-- For AWS: see `terraform/README.md` 
+- For AWS: see [`terraform/README.md`](terraform/README.md) 
 
 ---
 

build-all.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+
+echo "Building client..."
+cd client
+npm install
+npm run build
+cd ..
+
+echo "Building services..."
+cd server
+./gradlew clean build
+cd ..
+
+echo "Starting Docker Compose..."
+docker compose up --build

terraform/README.md

@@ -10,7 +10,7 @@ This guide explains how to use the Terraform scripts in this directory to provis
 
 2.  **AWS Credentials**:
     *   Once your AWS Academy Lab is running, obtain your AWS access key ID, secret access key, and session token.
-    *   Configure your local AWS CLI with these credentials. The simplest way is to run `aws configure` and enter the details. Alternatively, you can set them as environment variables or update your `~/.aws/credentials` file.
+    *   Configure your local AWS CLI with these credentials. The simplest way is to run `aws configure` and enter the details. Alternatively, you can update your `~/.aws/credentials` file.
 
 3.  **Software Installation**:
     *   **Terraform**: Ensure Terraform is installed on your local machine. You can download it from the [official Terraform website](https://www.terraform.io/downloads.html).