diff --git a/README.md b/README.md index 5ae4f46..dd54732 100644 --- a/README.md +++ b/README.md @@ -164,5 +164,6 @@ and submit a pull request. ### License -This project is licensed under the MIT License. See the LICENSE file for -more details. +This project is created and maintained by [Promptly Technologies, +LLC](https://promptlytechnologies.com/) and licensed under the MIT +License. See the LICENSE file for more details. diff --git a/_quarto.yml b/_quarto.yml index 875ef8a..b0f3023 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -20,6 +20,14 @@ website: text: Deployment - href: docs/contributing.qmd text: Contributing + right: + - icon: github + href: https://github.com/promptly-technologies-llc/fastapi-jinja2-postgres-webapp + page-footer: + left: "Copyright 2024, Promptly Technologies, LLC. MIT License." + right: + - icon: github + href: https://github.com/promptly-technologies-llc/fastapi-jinja2-postgres-webapp format: html: theme: cosmo diff --git a/docs/installation.qmd b/docs/installation.qmd index f36bc95..952d6b9 100644 --- a/docs/installation.qmd +++ b/docs/installation.qmd @@ -2,7 +2,7 @@ title: "Installation" --- -## Install development dependencies in a VSCode Dev Container +## Install all dependencies in a VSCode Dev Container If you use VSCode with Docker to develop in a container, the following VSCode Dev Container configuration will install all dependencies: @@ -10,7 +10,7 @@ If you use VSCode with Docker to develop in a container, the following VSCode De { "name": "Python 3", "image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye", - "postCreateCommand": "sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && pipx install poetry && poetry install && poetry shell", + "postCreateCommand": "sudo apt update && sudo apt install -y python3-dev libpq-dev graphviz && quarto add mcanouil/quarto-iconify && pipx install poetry && poetry install && poetry shell", "features": { "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}, "ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {} @@ -45,48 +45,53 @@ For Windows: - No installation required -### Quarto CLI and Graphviz +### Python dependencies -- [Quarto CLI](https://quarto.org/docs/get-started/) +1. Install Poetry +``` bash +pipx install poetry +``` -For macOS: +2. Install project dependencies ``` bash -brew install graphviz +poetry install ``` -For Ubuntu/Debian: +3. Activate shell ``` bash -sudo apt update && sudo apt install -y graphviz +poetry shell ``` -For Windows: +(Note: You will need to activate the shell every time you open a new terminal session. Alternatively, you can use the `poetry run` prefix before other commands to run them without activating the shell.) -- Download and install from [Graphviz.org](https://graphviz.org/download/#windows) +## Install documentation dependencies manually -### Python dependencies +### Quarto CLI -1. Install Poetry +To render the project documentation, you will need to download and install the [Quarto CLI](https://quarto.org/docs/get-started/) for your operating system. -``` bash -pipx install poetry -``` +### Graphviz -2. Install project dependencies +Architecture diagrams in the documentation are rendered with [Graphviz](https://graphviz.org/). + +For macOS: ``` bash -poetry install +brew install graphviz ``` -3. Activate shell +For Ubuntu/Debian: ``` bash -poetry shell +sudo apt update && sudo apt install -y graphviz ``` -(Note: You will need to activate the shell every time you open a new terminal session. Alternatively, you can use the `poetry run` prefix before other commands to run them without activating the shell.) +For Windows: + +- Download and install from [Graphviz.org](https://graphviz.org/download/#windows) ## Set environment variables diff --git a/index.qmd b/index.qmd index 93151fe..0266e7b 100644 --- a/index.qmd +++ b/index.qmd @@ -133,4 +133,4 @@ Your contributions are welcome! See the [issues page](https://github.com/promptl ### License -This project is licensed under the MIT License. See the LICENSE file for more details. +This project is created and maintained by [Promptly Technologies, LLC](https://promptlytechnologies.com/) and licensed under the MIT License. See the LICENSE file for more details.