Merge pull request #81 from KreativeThinker/master

chore: add run command and update readme

Author: KreativeThinker

README.md

@@ -26,7 +26,7 @@ A CTF platform backend written in [FastAPI](https://github.com/fastapi/fastapi)
 
 Before you begin, ensure you have met the following requirements:
 
-- Python 3.7+
+- Python 3.7+ (< Python 3.13)
 - Docker (optional, for container functionality)
 
 ## Installation
@@ -41,7 +41,7 @@ Before you begin, ensure you have met the following requirements:
 2. Set up a virtual environment:
 
    ```bash
-   python3 -m venv .venv
+   python3.12 -m venv .venv
    source .venv/bin/activate
    ```
 
@@ -62,11 +62,14 @@ Before you begin, ensure you have met the following requirements:
 1. Start:
 
    ```bash
-   cd src
    uvicorn pwncore:app --reload
+
+   # OR
+
+   poetry run dev
    ```
 
-2. Access the auto-generated documentation at [http://localhost:8000/docs](http://localhost:8000/docs)
+2. Access the auto-generated documentation at [http://localhost:8080/docs](http://localhost:8080/docs)
 
 3. Docker configuration:
    - Enable and start the Docker service on your system, or

pyproject.toml

@@ -64,3 +64,7 @@ pretty = true
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry.scripts]
+dev = "pwncore.__main__:run_dev"

src/pwncore/__main__.py

@@ -1,4 +1,9 @@
-from pwncore import app  # noqa
+import uvicorn
 
-# I do not trust my self to call uvicorn from here for debugging and
-# not use that in production
+
+def run_dev():
+    uvicorn.run("pwncore:app", host="127.0.0.1", port=8080, reload=True)
+
+
+if __name__ == "__main__":
+    run_dev()