📝 update README.md and add docker-compose.prod.yaml for production

Author: ge85riz

.env

@@ -0,0 +1,26 @@
+FRONTEND_PORT=5173
+SERVER_PORT=8000
+POSTGRES_PORT=5432
+
+# replace with server address like https://applicationserver.itestra.com:8000
+BACKEND_ADDRESS=http://localhost:8000
+# replace with server address like https://applicationserver.itestra.com:5173
+CLIENT_INSTANCE_ADDRESS=http://localhost:5173
+
+# credentials for admin username and password for postgres server
+# that we want to create
+DATABASE_NAME=postgres
+DATABASE_PASSWORD=5Hg0ClYBm3Fa
+DATABASE_USERNAME=grmykekuvhrpbj
+
+# replace with on-premise gitlab's address : https://gitlab.itestra.com
+GITLAB_INSTANCE_ADDRESS=https://gitlab.com
+GITLAB_INSTANCE_CLIENT_ID=xxxxxxxxxxxxxxxxxxx
+GITLAB_INSTANCE_CLIENT_SECRET=gloas-xxxxxxxxxxxxxxxxx
+
+# 64-char key (generate a new one for prod)
+JWT_SERVER_KEY=2e79b611f75ee73e4c258321276c2ad58bf55ed91656b2aff83408832476e3cc
+
+# constrain solver related parameters.
+CONSTRAINT_SOLVER_DURATION_LIMIT=300
+CONSTRAINT_SOLVER_SEARCH_WORKERS_COUNT=10

README.md

@@ -14,6 +14,7 @@ The **Event-Exchange-Platform** supports the organization of internal events at
 - Automatically allocate participants to seats using smart matching algorithms
 - Avoid repeated pairings across events
 
+
 ---
 
 ## ✨ Key Features
@@ -46,17 +47,22 @@ The **Event-Exchange-Platform** supports the organization of internal events at
 To run the platform locally or deploy on-premise:
 
 ```bash
-# Clone the repository
+  # Clone the repository
 git clone https://github.com/DigitalProductInnovationAndDevelopment/Event-Exchange-Platform.git
 
 # Navigate to project root
 cd Event-Exchange-Platform
 
 # Start all services using Docker Compose
-docker-compose up --build
+docker compose -f docker-compose.yaml up --build
 ```
 
-Ensure you have the appropriate `.env` file configured for environment-specific variables.
+Ensure you have the appropriate `.env` file configured for environment-specific variables for production
+You can take a look at the .env file in the GitHub repository.
+```bash
+  # Start all services using Docker Compose for production
+docker compose -f docker-compose.prod.yaml up --build
+```
 
 ---
 
@@ -76,6 +82,80 @@ You'll find step-by-step guides on:
 
 > This documentation is intended for both event organizers and developers contributing to the platform.
 
+---
+## GitLab Authentication Setup
+
+To use GitLab authentication with this application, you'll need to obtain a Client ID and Client Secret from GitLab. Follow these steps:
+
+### Creating a GitLab OAuth Application
+
+1. **Sign in to GitLab**
+    - Navigate to [gitlab.com](https://gitlab.com) (or your GitLab instance)
+    - Sign in with your GitLab account
+
+2. **Access User Settings**
+    - Click on your profile picture in the top-right corner
+    - Select "Edit profile"
+    - ![Screenshot Where to Edit Profile](backend/readme_assets/gitlab1.png)
+
+3. **Navigate to Applications**
+    - In the left sidebar, click on "Applications"
+    - Click the "New application" button
+    - ![Screenshot Where to Applications](backend/readme_assets/gitlab2.png)
+    - ![Screenshot Where to New Application](backend/readme_assets/gitlab3.png)
+   
+4. **Configure Your Application**
+    - **Name**: Enter a descriptive name for your application (e.g., "My App Name")
+    - **Redirect URI**: Enter your application's callback URL
+      ```
+      https://applicationserver.itestra.com:8000/login/oauth2/code/gitlab
+      ```
+      *Note: Replace with your actual domain and callback path in production*
+    - **Scopes**: Select the required scopes for your application:
+        - `read_user` - Read user information
+    - **Confidential**: Leave this checked (recommended for server-side applications)
+    - ![Screenshot Where to Configure Application](backend/readme_assets/gitlab4.png)
+5. **Save the Application**
+    - Click "Save application"
+
+6. **Copy Your Credentials**
+   After creating the application, you'll see:
+    - **Application ID** (this is your `CLIENT_ID`)
+    - **Secret** (this is your `CLIENT_SECRET`)
+
+   ⚠️ **Important**: Copy these values immediately and store them securely. The secret will not be shown again.
+
+   - ![Screenshot Where to Get Credentials](backend/readme_assets/gitlab5.png)
+
+## Environment Configuration
+
+Add the obtained credentials to your environment variables:
+
+```bash
+# .env file
+GITLAB_INSTANCE_CLIENT_ID=your_application_id_here
+GITLAB_INSTANCE_CLIENT_SECRET=your_secret_here
+```
+
+## For GitLab Self-Managed Instances
+
+If you're using a self-managed GitLab instance:
+
+1. Replace `gitlab.com` with your GitLab instance URL
+2. Follow the same steps above on your instance
+3. Update your application configuration to point to your GitLab instance:
+
+```bash
+GITLAB_INSTANCE_ADDRESS=https://your-gitlab-instance.com
+```
+
+## Security Notes
+
+- Keep your Client Secret confidential and never commit it to version control
+- Use environment variables or secure secret management systems
+- In production, ensure your redirect URI uses HTTPS
+- Regularly rotate your credentials for enhanced security
+
 ---
 
 ## 📦 Repository Structure
@@ -84,8 +164,9 @@ You'll find step-by-step guides on:
 Event-Exchange-Platform/
 ├── backend/                 # Spring Boot backend
 ├── frontend/                # React + Tailwind frontend
-├── docker-compose.yml       # Service orchestration
-├── .env.example             # Sample environment config
+├── docker-compose.yml       # Service orchestration for development/test
+├── docker-compose.prod.yml  # Service orchestration for production
+├── .env                     # Sample environment config
 └── README.md                # You're here!
 ```
 

backend/README.md

@@ -2,7 +2,7 @@
 
 Download the backend repository.
 
-There should be a `docker-compose.yaml` file in the project's root directory.
+There should be a `docker-compose.yaml` file in the backend directory.
 
 Run `docker compose up`.
 

backend/readme_assets/gitlab1.png

@@ -12,7 +12,7 @@ public class ConstraintSolverConstraintsDTO implements Serializable {
     @JsonProperty("Standort")
     int place;
 
-    @JsonProperty("Anstellung")
+    @JsonProperty("Zugehörigkeit")
     int employmentDuration;
 
     @JsonProperty("Geschlecht")

backend/readme_assets/gitlab2.png

@@ -34,5 +34,7 @@ public interface EmployeeParticipationRepository extends JpaRepository<EmployeeP
             "            and pm.id.firstEmployeeId = pm2.id.secondEmployeeId)")
     List<Object[]> findEmployeePairsOfCurrentEventThatAreAcquaintedFromPreviousEvents(Set<UUID> previousEventIds, UUID currentEventId);
 
+    @Query("select e.employee.id from EmployeeParticipation e where e.eventId = ?1")
+    Set<UUID> findAllEmployeeParticipantIdsOfEvent(UUID eventId);
 
 }