CHIEFSOFT\ameye
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# 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. 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:5000`.
|
|
|
|
### 3. 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:5000/health
|
|
```
|
|
|
|
If the application is running properly, you should receive a response similar to this:
|
|
|
|
```json
|
|
{
|
|
"status": "ok"
|
|
}
|
|
```
|
|
|
|
### 4. Stop the Application
|
|
|
|
To stop the application, use:
|
|
|
|
```bash
|
|
docker-compose down
|
|
```
|
|
|
|
This will stop and remove the containers created by Docker Compose.
|