Merge pull request #6 from dele-work/feat/automatically-use-an-unspecified-port

feat: Automatically use an unspecified port

Author: kai0310

.gitignore

@@ -138,3 +138,4 @@ sonarqube/logs
 .idea
 .DS_Store
 
+.port

Makefile

@@ -17,39 +17,37 @@ help:
 	@echo "    run-prod"
 	@echo "        Run production docker compose."
 	@echo "    stop-prod"
-	@echo "        Run production docker compose."	
+	@echo "        Run production docker compose."
 	@echo "    formatter"
 	@echo "        Apply black formatting to code."
 	@echo "    mypy"
-	@echo "        Check typing."		
+	@echo "        Check typing."
 	@echo "    lint"
 	@echo "        Lint code with ruff, and check if black formatter should be applied."
 	@echo "    lint-watch"
 	@echo "        Lint code with ruff in watch mode."
 	@echo "    lint-fix"
-	@echo "        Lint code with ruff and try to fix."	
-	
+	@echo "        Lint code with ruff and try to fix."
+
 install:
 	cd src && poetry install && cd ../..
 
 run-app:
 	cd src && poetry run uvicorn app.main:app --host 0.0.0.0 --port 8000 && cd ..
 
-
 run-dev-build:
-	docker compose -f docker-compose-dev.yml up --build
+	$(MAKE) find-port
+	docker-compose up --build
 
 run-dev:
-	docker compose -f docker-compose-dev.yml up
+	$(MAKE) find-port
+	docker-compose up
 
 stop-dev:
-	docker compose -f docker-compose-dev.yml down
-
-run-prod:
-	docker compose up --build
+	docker-compose down
 
 stop-prod:
-	docker compose down
+	docker-compose down
 
 formatter:
 	cd src && \
@@ -70,3 +68,12 @@ lint-watch:
 lint-fix:
 	cd src && \
 	poetry run ruff app --fix
+
+find-port:
+	@echo "Finding available port..."
+	@PORT=8000; \
+	while lsof -Pi :$$PORT -sTCP:LISTEN -t >/dev/null ; do \
+		PORT=$$((PORT+1)); \
+	done; \
+	echo "\033[0;32mUsing available port: $$PORT\033[0m"; \
+	sed -i.bak "s/8000:8000/$$PORT:8000/g" docker-compose.yml

README.md

@@ -36,7 +36,9 @@ make run-app
 
 Open [http://localhost:8000/docs](http://localhost:8000/docs) with your browser to see the result.
 
-You can start editing the server by modifying `app/main.py`.
+By default, the server uses port 8000. However, if this port is already in use, the server will automatically increment and select the next available port, ensuring the application remains accessible.
+
+You can start editing the server by modifying `src/app/main.py`.
 
 - [fastapi-alembic-sqlmodel-async](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async).
 - [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql).

docker-compose-dev.yml

@@ -5,11 +5,11 @@ services:
     container_name: ${PROJECT_NAME}_fastapi_server
     build: ./
     restart: always
-    command: "sh -c 'gunicorn -w 3 -k uvicorn.workers.UvicornWorker app.main:app  --bind 0.0.0.0:8000 --preload --log-level=debug --timeout 120'"
+    command: "sh -c 'uvicorn app.main:app --reload --workers 3 --host 0.0.0.0 --port 8000'"
     volumes:
       - ./src:/code
-    expose:
-      - 8000
+    ports:
+      - "8001:8000"
     env_file: ".env"
 
   caddy_reverse_proxy:
@@ -30,4 +30,4 @@ services:
 
 volumes:
   caddy_data:
-  caddy_config:
+  caddy_config: