⚙️ [GH-74] Some fixes (#75)

* fix: update Dockerfile and add psql port to dsn build [#74]

* fix: int instead of string [#74]

* chore: version bump [#74]

* docs: update README and quickstart [#74]

Author: nickatnight

README.md

@@ -20,28 +20,32 @@
 Supported PaaS's:
 - Render
 - Platform.sh (Coming soon)
-- Porter (Coming soon)
 - Fly.io (Coming soon)
 - DigitalOcean (Coming soon)
 
 ## Quickstart
 Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):
 ```sh
-pip install cookiecutter
+# pipx is strongly recommended.
+$ pipx install cookiecutter
+
+# If pipx is not an option,
+# you can install cookiecutter in your Python user directory.
+$ python -m pip install --user cookiecutter
 ```
 
 Generate project from GitHub template:
 
 ```sh
-$ cookiecutter gh:nickatnight/cookiecutter-fastapi-backend.git
+$ pipx run cookiecutter gh:nickatnight/cookiecutter-fastapi-backend
 ```
 
 Or from Python code:
 
 ```python
 from cookiecutter.main import cookiecutter
 
-cookiecutter("gh:nickatnight/cookiecutter-fastapi-backend.git")
+cookiecutter("gh:nickatnight/cookiecutter-fastapi-backend")
 ```
 
 ## Features

docs/source/getting_started/quickstart.rst

@@ -5,7 +5,7 @@ To get started, install the latest version of `Cookiecutter <https://github.com/
 
 .. code-block:: bash
 
-    pip install cookiecutter
+    pipx install cookiecutter
 
 Then, generate a new project
 
@@ -18,14 +18,14 @@ Using a GitHub templates:
 
 .. code-block:: bash
 
-    cookiecutter gh:nickatnight/cookiecutter-fastapi-backend.git
+    pipx run cookiecutter gh:nickatnight/cookiecutter-fastapi-backend
 
 
 Using a local template:
 
 .. code-block:: bash
 
-    cookiecutter cookiecutter-fastapi-backend
+    pipx run cookiecutter cookiecutter-fastapi-backend
 
 Using from Python:
 
@@ -37,7 +37,7 @@ Using from Python:
     cookiecutter("cookiecutter-fastapi-backend/")
 
     # Create project from the cookiecutter-fastapi-backend.git repo template
-    cookiecutter("gh:nickatnight/cookiecutter-fastapi-backend.git")
+    cookiecutter("gh:nickatnight/cookiecutter-fastapi-backend")
 
 Input Variables
 ---------------

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cookiecutter-fastapi-backend"
-version = "2.2.0"
+version = "2.2.1"
 description = "Cookiecutter template to build and deploy fastapi backends..batteries included"
 authors = [{ name = "nickatnight", email = "nialexanderke@proton.me" }]
 requires-python = ">=3.9"

uv.lock

@@ -7,6 +7,8 @@ WORKDIR /code
 
 ENV PATH="/code/.venv/bin:$PATH"
 
+ADD pyproject.toml /code/
+
 # Compile bytecode
 # Ref: https://docs.astral.sh/uv/guides/integration/docker/#compiling-bytecode
 ENV UV_COMPILE_BYTECODE=1
@@ -20,7 +22,7 @@ RUN --mount=type=cache,target=/root/.cache/uv \
     --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
     uv sync --no-install-project
 
-# Copy the project into the image
+# Copy remaining project files into the image
 ADD . /code
 
 # Sync the project

{{ cookiecutter.project_slug }}/{{ cookiecutter.backend_container_name }}/Dockerfile

@@ -52,6 +52,7 @@ def build_db_connection(cls, v: Optional[str], values: ValidationInfo) -> Any:
             password=values.data.get("POSTGRES_PASSWORD"),
             host=values.data.get("POSTGRES_HOST"),
             path=f"{values.data.get('POSTGRES_DB') or ''}",
+            port=int(values.data.get("POSTGRES_PORT", "5432")),
         ).unicode_string()
     {%- if cookiecutter.use_celery == "yes" %}