Merge pull request #125 from ks6088ts-labs/cosmetic

refactor codes

Author: ks6088ts

Makefile

@@ -52,10 +52,10 @@ ci-test: install-deps-dev format-check lint test ## run CI tests
 # ---
 DOCKER_REPO_NAME ?= ks6088ts
 DOCKER_IMAGE_NAME ?= azure-ai-services-solutions
-DOCKER_IMAGE_COMPONENT ?= backend
+DOCKER_SERVICE_NAME ?= backend
 DOCKER_COMMAND ?=
-DOCKER_TAG ?= $(DOCKER_IMAGE_COMPONENT)-$(GIT_TAG)
-DOCKER_FILE ?= ./dockerfiles/$(DOCKER_IMAGE_COMPONENT).Dockerfile
+DOCKER_TAG ?= $(DOCKER_SERVICE_NAME)-$(GIT_TAG)
+DOCKER_FILE ?= ./$(DOCKER_SERVICE_NAME)/Dockerfile
 DOCKER_COMPOSE_FILE ?= ./compose.yaml
 
 # Tools
@@ -95,15 +95,16 @@ _ci-test-docker: docker-lint docker-build docker-scan docker-run
 
 .PHONY: ci-test-docker
 ci-test-docker: docker-compose-lint ## run CI test for Docker
-	$(MAKE) _ci-test-docker DOCKER_IMAGE_COMPONENT=backend
-	$(MAKE) _ci-test-docker DOCKER_IMAGE_COMPONENT=frontend
+	$(MAKE) _ci-test-docker DOCKER_SERVICE_NAME=backend
+	$(MAKE) _ci-test-docker DOCKER_SERVICE_NAME=frontend
 
 # ---
 # Application
 # ---
 .PHONY: backend
 backend: ## run backend
-	poetry run python main.py backend --reload
+	cd backend \
+		&& poetry run python main.py backend --reload
 
 .PHONY: frontend
 frontend: ## run frontend
@@ -115,7 +116,8 @@ frontend: ## run frontend
 # ---
 .PHONY: azure-functions-start
 azure-functions-start: ## start Azure Functions
-	poetry run func start
+	cd backend \
+		&& poetry run func start
 
 .PHONY: azure-functions-deploy
 azure-functions-deploy: ## deploy Azure Functions resources
@@ -125,21 +127,17 @@ azure-functions-deploy: ## deploy Azure Functions resources
 azure-functions-destroy: ## destroy Azure Functions resources
 	sh ./scripts/destroy-azure-functions.sh
 
-.PHONY: azure-functions-functionapp-deploy
-azure-functions-functionapp-deploy: ## deploy Azure Functions App
-	poetry export \
-		--format requirements.txt \
-		--output requirements.txt \
-		--with backend,azure-functions \
-		--without-hashes
-	func azure functionapp publish $(shell jq -r '.FUNCTION_APP_NAME' < azure-functions.json)
+.PHONY: azure-functions-publish
+azure-functions-publish: ## publish Azure Functions App
+	sh ./scripts/publish-azure-functions.sh
 
 # ---
 # OpenAPI Client
 # ---
 .PHONY: generate-openapi-spec
 generate-openapi-spec: ## generate OpenAPI spec
-	poetry run python main.py generate-openapi-spec
+	cd backend \
+		&& poetry run python main.py generate-openapi-spec
 
 .PHONY: generate-openapi-client
 generate-openapi-client: ## generate OpenAPI client

README.md

@@ -24,30 +24,26 @@ This repository contains a collection of solutions that leverage Azure AI servic
 Use Makefile to run the project locally.
 
 ```shell
-# help
-make
+# Launch backend API server
+make backend
 
-# install dependencies for development
-make install-deps-dev
+# Launch frontend app server
+make frontend
 
-# run tests
-make test
-
-# run CI tests
-make ci-test
+# Azure Functions
+make azure-functions-start
 ```
 
 ### Docker development
 
-```shell
-# build docker image
-make docker-build
+See the actual implementation in the [compose.yaml](./compose.yaml) file.
 
-# run docker container
-make docker-run
+```shell
+# Launch backend API server
+docker compose up backend
 
-# run CI tests in docker container
-make ci-test-docker
+# Launch frontend app server
+docker compose up frontend
 ```
 
 ### Run local test
@@ -64,18 +60,19 @@ make test
 
 ## Deployment instructions
 
-### Docker compose
+```shell
+# Deploy Azure resources via Bicep
+cd infra
+make deploy
+```
 
-Docker compose is used to run the services locally.
-Refer to the following steps to run the services.
-See the actual implementation in the [compose.yaml](./compose.yaml) file.
+Azure Functions are deployed using the following commands.
 
 ```shell
-# Create environment files for each service
-cp ./settings/{NAME}.env.sample ./settings/{NAME}.env
-
-# Build and run the services
-docker compose up
+# Deploy Azure Functions
+make azure-functions-deploy
+# Publish Azure Functions
+make azure-functions-publish
 ```
 
 ### Push docker image to Docker Hub
@@ -86,18 +83,3 @@ To publish the docker image to Docker Hub via GitHub Actions, you need to set th
 gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME
 gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN
 ```
-
-### Deploy Azure Functions
-
-To deploy the Azure Functions, run the following script.
-
-```shell
-# Deploy the Azure Functions
-sh ./scripts/deploy-azure-functions.sh
-
-# Destroy the Azure Functions
-sh ./scripts/destroy-azure-functions.sh
-```
-
-- [scripts/deploy-azure-functions.sh](./scripts/deploy-azure-functions.sh): Deploy the Azure Functions using Azure CLI.
-- [scripts/destroy-azure-functions.sh](./scripts/destroy-azure-functions.sh): Destroy the Azure Functions using Azure CLI.

.funcignore renamed to backend/.funcignore

@@ -1,4 +1,4 @@
-FROM python:3.11.8-slim-bookworm as requirements-stage
+FROM python:3.11.8-slim-bookworm AS requirements-stage
 
 WORKDIR /tmp
 
@@ -16,7 +16,7 @@ ARG GIT_TAG="x.x.x"
 WORKDIR /app
 
 COPY --from=requirements-stage /tmp/requirements.txt /app/requirements.txt
-COPY . .
+COPY ./backend/ .
 
 # Install dependencies
 RUN pip install --no-cache-dir --upgrade -r /app/requirements.txt