|
109 | 109 | "href": "index.html#installation", |
110 | 110 | "title": "FastAPI, Jinja2, PostgreSQL Webapp Template", |
111 | 111 | "section": "Installation", |
112 | | - "text": "Installation\nFor comprehensive installation instructions, see the installation page.\n\nuv\nMacOS and Linux:\nwget -qO- https://astral.sh/uv/install.sh | sh\nWindows:\npowershell -ExecutionPolicy ByPass -c \"irm https://astral.sh/uv/install.ps1 | iex\"\nSee the uv installation docs for more information.\n\n\nPython\nInstall Python 3.12 or higher from either the official downloads page or using uv:\n# Installs the latest version\nuv python install\n\n\nDocker and Docker Compose\nInstall Docker Desktop and Coker Compose for your operating system by following the instructions in the documentation.\n\n\nPostgreSQL headers\nFor Ubuntu/Debian:\nsudo apt update && sudo apt install -y python3-dev libpq-dev libwebp-dev\nFor macOS:\nbrew install postgresql\nFor Windows:\n\nNo installation required\n\n\n\nPython dependencies\nFrom the root directory, run:\nuv venv\nuv sync\nThis will create an in-project virtual environment and install all dependencies.\n\n\nSet environment variables\nCopy .env.example to .env with cp .env.example .env.\nGenerate a 256 bit secret key with openssl rand -base64 32 and paste it into the .env file.\nSet your desired database name, username, and password in the .env file.\nTo use password recovery, register a Resend account, verify a domain, get an API key, and paste the API key into the .env file.\n\n\nStart development database\nTo start the development database, run the following command in your terminal from the root directory:\ndocker compose up -d\n\n\nRun the development server\nMake sure the development database is running and tables and default permissions/roles are created first.\nuv run python -m uvicorn main:app --host 0.0.0.0 --port 8000 --reload\nNavigate to http://localhost:8000/\n\n\nLint types with mypy\nuv run mypy ." |
| 112 | + "text": "Installation\nFor comprehensive installation instructions, see the installation page.\n\nuv\nMacOS and Linux:\nwget -qO- https://astral.sh/uv/install.sh | sh\nWindows:\npowershell -ExecutionPolicy ByPass -c \"irm https://astral.sh/uv/install.ps1 | iex\"\nSee the uv installation docs for more information.\n\n\nPython\nInstall Python 3.12 or higher from either the official downloads page or using uv:\n# Installs the latest version\nuv python install\n\n\nDocker and Docker Compose\nInstall Docker Desktop and Coker Compose for your operating system by following the instructions in the documentation.\n\n\nPostgreSQL headers\nFor Ubuntu/Debian:\nsudo apt update && sudo apt install -y python3-dev libpq-dev libwebp-dev\nFor macOS:\nbrew install postgresql\nFor Windows:\n\nNo installation required\n\n\n\nPython dependencies\nFrom the root directory, run:\nuv venv\nuv sync\nThis will create an in-project virtual environment and install all dependencies.\n\n\nSet environment variables\nCopy .env.example to .env with cp .env.example .env.\nGenerate a 256 bit secret key with openssl rand -base64 32 and paste it into the .env file.\nSet your desired database name, username, and password in the .env file.\nTo use password recovery and other email features, register a Resend account, verify a domain, get an API key, and paste the API key and the email address you want to send emails from into the .env file. Note that you will need to verify a domain through the Resend dashboard to send emails from that domain.\n\n\nStart development database\nTo start the development database, run the following command in your terminal from the root directory:\ndocker compose up -d\n\n\nRun the development server\nMake sure the development database is running and tables and default permissions/roles are created first.\nuv run python -m uvicorn main:app --host 0.0.0.0 --port 8000 --reload\nNavigate to http://localhost:8000/\n\n\nLint types with mypy\nuv run mypy ." |
113 | 113 | }, |
114 | 114 | { |
115 | 115 | "objectID": "index.html#developing-with-llms", |
|
179 | 179 | "href": "docs/installation.html#set-environment-variables", |
180 | 180 | "title": "Installation", |
181 | 181 | "section": "Set environment variables", |
182 | | - "text": "Set environment variables\nCopy .env.example to .env with cp .env.example .env.\nGenerate a 256 bit secret key with openssl rand -base64 32 and paste it into the .env file.\nSet your desired database name, username, and password in the .env file.\nTo use password recovery, register a Resend account, verify a domain, get an API key, and paste the API key into the .env file.\nIf using the dev container configuration, you will need to set the DB_HOST environment variable to “host.docker.internal” in the .env file. Otherwise, set DB_HOST to “localhost” for local development. (In production, DB_HOST will be set to the hostname of the database server.)" |
| 182 | + "text": "Set environment variables\nCopy .env.example to .env with cp .env.example .env.\nGenerate a 256 bit secret key with openssl rand -base64 32 and paste it into the .env file.\nSet your desired database name, username, and password in the .env file.\nTo use password recovery, register a Resend account, verify a domain, get an API key, and paste the API key and sender email address into the .env file.\nIf using the dev container configuration, you will need to set the DB_HOST environment variable to “host.docker.internal” in the .env file. Otherwise, set DB_HOST to “localhost” for local development. (In production, DB_HOST will be set to the hostname of the database server.)" |
183 | 183 | }, |
184 | 184 | { |
185 | 185 | "objectID": "docs/installation.html#start-development-database", |
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments