first commit

README.md

@@ -0,0 +1,101 @@
+# Setup
+
+This guide provides instructions on how to set up and run the application.
+
+## Prerequisites
+
+Ensure you have the following installed on your system:
+- **Docker**: Install Docker from [docker.com](https://www.docker.com/get-started)
+- **Docker Compose**: Docker Compose is included with Docker Desktop (for macOS/Windows) or can be installed separately on Linux.
+
+## Steps to Set Up the Application
+
+### 1. Clone the Repository
+
+First, clone the repository to your local machine:
+
+```bash
+git clone https://github.com/username/repository.git
+cd repository
+```
+
+
+### 2. Configure Environment Variables
+
+Instead of creating a new `.env` file, rename the provided `.env.example` file and update the necessary variables:
+
+```bash
+cp .env.example .env
+```
+
+Then, open the `.env` file and **update the following variables with your actual configuration:**
+
+- Database credentials:
+  ```ini
+  DATABASE_USER=your_database_username
+  DATABASE_PASSWORD=your_database_password
+  DATABASE_NAME=your_database_name
+  DATABASE_PORT=5432
+  ```
+- App ID and API Key:
+  ```ini
+  APP_ID=your_app_id
+  API_KEY=your_api_key
+  ```
+
+This ensures that the application is properly configured with your environment variables.
+
+> **Optional:** Change file permissions for the entrypoint script
+
+```bash
+chmod +x scripts/entrypoint.sh
+```
+
+---
+
+
+### 3. Run the Application with Docker Compose
+
+Once you have the repository cloned, you can easily set up and run the application using Docker Compose. Simply execute the following command:
+
+```bash
+docker-compose up --build
+```
+
+This command will build the Docker image and start the Flask application in a container. By default, the application will be accessible at `http://localhost:4500`.
+
+### 4. Health Check
+
+You can check if the Flask application is running by accessing the `/health` endpoint. To perform a health check, run the following command:
+
+```bash
+curl http://localhost:4500/health
+```
+
+If the application is running properly, you should receive a response similar to this:
+
+```json
+{
+  "status": "ok"
+}
+```
+
+
+### 5. Documentation
+
+You can check the Swagger Doc by accessing the `/documentation` endpoint. Run the following command:
+
+```bash
+curl http://localhost:4500/documentation
+```
+
+
+### 6. Stop the Application
+
+To stop the application, use:
+
+```bash
+docker-compose down
+```
+
+This will stop and remove the containers created by Docker Compose.