From d76887ccb11f71752959d00e9f0c4893231bc917 Mon Sep 17 00:00:00 2001
From: Mouaz Abdelsamad <ma03081@surrey.ac.uk>
Date: Sat, 4 May 2024 00:20:04 +0100
Subject: [PATCH] add readme file

---
 .readme | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 .readme

diff --git a/.readme b/.readme
new file mode 100644
index 0000000..e6ee47d
--- /dev/null
+++ b/.readme
@@ -0,0 +1,39 @@
+# Flight Booking Service Website
+
+Welcome to the repository for the flight booking service website. This project utilizes a microservices architecture, with each microservice (Client App, Booking Microservice, User Microservice, Flight Microservice, and Gateway API) housed in its respective directory.
+
+## CI/CD Pipeline
+The `.gitlab-ci.yml` file contains the CI/CD pipeline configurations to automate the delivery of the website.
+
+## Dockerization
+The services are containerized using Docker. The `docker-compose.yml` file is used to build and run the services in Docker containers.
+
+## Configuration
+The `.env` file contains configuration settings that allow you to change the ports of the services, if there be any port conflicts.
+
+## Building and Running Services
+To build the services, run the following command in the terminal:
+```bash
+docker-compose build
+```
+
+After building, you can start the services using:
+
+```bash
+docker-compose up
+```
+
+## Database Initialization
+
+The database image is pre-populated with default values for testing. Currently, the database is configured with an Airline account:
+
+- Email: skyHigh@gmail.com
+- Password: 123456789
+
+This account manages two flights:
+
+- From London Heathrow to Glasgow
+- From London Heathrow to Liverpool
+
+Both flights are scheduled for 15/7/2024.
+
-- 
GitLab