CIMS-4 - Install fastapi and spin up local Hello World application

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.12.6
+
+WORKDIR /app
+
+COPY pyproject.toml poetry.lock /app/
+
+RUN pip install --no-cache-dir poetry==1.8.4 && poetry install --no-root --no-dev
+
+COPY . /app
+
+CMD ["poetry", "run", "uvicorn", "src.main:app", "--host", "0.0.0.0", "--port", "5010"]

Makefile

@@ -28,11 +28,11 @@ lint:  ## Run all linters (black/ruff/pylint/mypy).
 
 .PHONY: test
 test:  ## Run the tests and check coverage.
-	poetry run pytest -n auto --cov=eq_cir_converter_service --cov-report term-missing --cov-fail-under=100
+	poetry run pytest -n auto --cov=src --cov-report term-missing --cov-fail-under=100
 
 .PHONY: mypy
 mypy:  ## Run mypy.
-	poetry run mypy eq_cir_converter_service
+	poetry run mypy src
 
 .PHONY: install
 install:  ## Install the dependencies excluding dev.
@@ -48,3 +48,19 @@ megalint:  ## Run the mega-linter.
 		-v /var/run/docker.sock:/var/run/docker.sock:rw \
 		-v $(shell pwd):/tmp/lint:rw \
 		oxsecurity/megalinter:v7
+
+.PHONY: run
+run:  ## Start the local application.
+	poetry run uvicorn src.main:app --reload --port 5010
+
+.PHONY: docker-build
+docker-build:  ## Build the docker image.
+	docker build -t cir-converter-service .
+
+.PHONY: docker-compose-up
+docker-compose-up:  ## Start the docker container using docker-compose.
+	docker-compose up -d
+
+.PHONY: docker-compose-down
+docker-compose-down:  ## Stop the docker container using docker-compose.
+	docker-compose down

README.md

@@ -24,6 +24,10 @@ This repository is for the CIR Converter service Python FastAPI application
 - [Development](#development)
     - [Run Tests with Coverage](#run-tests-with-coverage)
     - [Linting and Formatting](#linting-and-formatting)
+    - [Build the docker image](#build-the-docker-image)
+    - [Start the docker container](#start-the-docker-container)
+    - [View the local application](#view-the-local-application)
+    - [Stop the docker container](#stop-the-docker-container)
 - [Contributing](#contributing)
 - [License](#license)
 <!-- markdown-link-check-enable -->
@@ -137,6 +141,30 @@ To start the linter and automatically rectify fixable issues, run:
 make megalint
 ```
 
+### Build the docker image
+
+```bash
+make docker-build
+```
+
+### Start the docker container
+
+```bash
+make docker-compose-up
+```
+
+### View the local application
+
+<!-- markdown-link-check-disable-next-line -->
+- Navigate to [http://localhost:5010/docs](http://localhost:5010/docs) to view the FastAPI application
+- View the API endpoints available and test to see the response
+
+### Stop the docker container
+
+```bash
+make docker-compose-down
+```
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  web:
+    build: .
+    ports:
+      - "5010:5010"
+    volumes:
+      - .:/app