Skip to content

Added copyright notice and Github icon links to documentation website #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 8 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
45 changes: 25 additions & 20 deletions docs/installation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
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:

``` json
{
"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": {}
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.