|
39 | 39 | "href": "index.html#installation", |
40 | 40 | "title": "FastAPI, Jinja2, PostgreSQL Webapp Template", |
41 | 41 | "section": "Installation", |
42 | | - "text": "Installation\nFor comprehensive installation instructions, see the installation page.\n\nPython and Docker\n\nPython 3.12 or higher\nDocker and Docker Compose\n\n\n\nPostgreSQL headers\nFor Ubuntu/Debian:\nsudo apt update && sudo apt install -y python3-dev libpq-dev\nFor macOS:\nbrew install postgresql\nFor Windows:\n\nNo installation required\n\n\n\nPython dependencies\n\nInstall Poetry\n\npipx install poetry\n\nInstall project dependencies\n\npoetry install\n\nActivate shell\n\npoetry shell\n(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.)\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\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.\nuvicorn main:app --host 0.0.0.0 --port 8000 --reload\nNavigate to http://localhost:8000/\n\n\nLint types with mypy\nmypy .\n\n\nContributing\nYour contributions are welcome! See the issues page for ideas. Fork the repository, create a new branch, make your changes, and submit a pull request.\n\n\nLicense\nThis project is created and maintained by Promptly Technologies, LLC and licensed under the MIT License. See the LICENSE file for more details." |
| 42 | + "text": "Installation\nFor comprehensive installation instructions, see the installation page.\n\nPython and Docker\n\nPython 3.12 or higher\nDocker and Docker Compose\n\n\n\nPostgreSQL headers\nFor Ubuntu/Debian:\nsudo apt update && sudo apt install -y python3-dev libpq-dev\nFor macOS:\nbrew install postgresql\nFor Windows:\n\nNo installation required\n\n\n\nPython dependencies\n\nInstall Poetry\n\npipx install poetry\n\nInstall project dependencies\n\npoetry install\n\nActivate shell\n\npoetry shell\n(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.)\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\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.\nuvicorn main:app --host 0.0.0.0 --port 8000 --reload\nNavigate to http://localhost:8000/\n\n\nLint types with mypy\nmypy ." |
| 43 | + }, |
| 44 | + { |
| 45 | + "objectID": "index.html#developing-with-llms", |
| 46 | + "href": "index.html#developing-with-llms", |
| 47 | + "title": "FastAPI, Jinja2, PostgreSQL Webapp Template", |
| 48 | + "section": "Developing with LLMs", |
| 49 | + "text": "Developing with LLMs\nIn line with the llms.txt standard, we have exposed the full Markdown-formatted project documentation as a single text file to make it more usable by LLM agents." |
| 50 | + }, |
| 51 | + { |
| 52 | + "objectID": "index.html#contributing", |
| 53 | + "href": "index.html#contributing", |
| 54 | + "title": "FastAPI, Jinja2, PostgreSQL Webapp Template", |
| 55 | + "section": "Contributing", |
| 56 | + "text": "Contributing\nYour contributions are welcome! See the issues page for ideas. Fork the repository, create a new branch, make your changes, and submit a pull request." |
| 57 | + }, |
| 58 | + { |
| 59 | + "objectID": "index.html#license", |
| 60 | + "href": "index.html#license", |
| 61 | + "title": "FastAPI, Jinja2, PostgreSQL Webapp Template", |
| 62 | + "section": "License", |
| 63 | + "text": "License\nThis project is created and maintained by Promptly Technologies, LLC and licensed under the MIT License. See the LICENSE file for more details." |
43 | 64 | }, |
44 | 65 | { |
45 | 66 | "objectID": "docs/contributing.html", |
|
116 | 137 | "href": "docs/customization.html", |
117 | 138 | "title": "Customization", |
118 | 139 | "section": "", |
119 | | - "text": "The project uses Poetry to manage dependencies:\n\nAdd new dependency: poetry add <dependency>\nAdd development dependency: poetry add --dev <dependency>\nRemove dependency: poetry remove <dependency>\nUpdate lock file: poetry lock\nInstall dependencies: poetry install\nUpdate all dependencies: poetry update\n\n\n\n\nThe project uses Pytest for unit testing. It’s highly recommended to write and run tests before committing code to ensure nothing is broken!\nThe following fixtures, defined in tests/conftest.py, are available in the test suite:\n\nengine: Creates a new SQLModel engine for the test database.\nset_up_database: Sets up the test database before running the test suite by dropping all tables and recreating them to ensure a clean state.\nsession: Provides a session for database operations in tests.\nclean_db: Cleans up the database tables before each test by deleting all entries in the PasswordResetToken and User tables.\nclient: Provides a TestClient instance with the session fixture, overriding the get_session dependency to use the test session.\ntest_user: Creates a test user in the database with a predefined name, email, and hashed password.\n\nTo run the tests, use these commands:\n\nRun all tests: pytest\nRun tests in debug mode (includes logs and print statements in console output): pytest -s\nRun particular test files by name: pytest <test_file_name>\nRun particular tests by name: pytest -k <test_name>\n\n\n\n\nThe project uses type annotations and mypy for static type checking. To run mypy, use this command from the root directory:\nmypy\nWe find that mypy is an enormous time-saver, catching many errors early and greatly reducing time spent debugging unit tests. However, note that mypy requires you type annotate every variable, function, and method in your code base, so taking advantage of it is a lifestyle change!" |
| 140 | + "text": "The project uses Poetry to manage dependencies:\n\nAdd new dependency: poetry add <dependency>\nAdd development dependency: poetry add --dev <dependency>\nRemove dependency: poetry remove <dependency>\nUpdate lock file: poetry lock\nInstall dependencies: poetry install\nUpdate all dependencies: poetry update\n\n\n\n\nThe project uses Pytest for unit testing. It’s highly recommended to write and run tests before committing code to ensure nothing is broken!\nThe following fixtures, defined in tests/conftest.py, are available in the test suite:\n\nengine: Creates a new SQLModel engine for the test database.\nset_up_database: Sets up the test database before running the test suite by dropping all tables and recreating them to ensure a clean state.\nsession: Provides a session for database operations in tests.\nclean_db: Cleans up the database tables before each test by deleting all entries in the PasswordResetToken and User tables.\nclient: Provides a TestClient instance with the session fixture, overriding the get_session dependency to use the test session.\ntest_user: Creates a test user in the database with a predefined name, email, and hashed password.\n\nTo run the tests, use these commands:\n\nRun all tests: pytest\nRun tests in debug mode (includes logs and print statements in console output): pytest -s\nRun particular test files by name: pytest <test_file_name>\nRun particular tests by name: pytest -k <test_name>\n\n\n\n\nThe project uses type annotations and mypy for static type checking. To run mypy, use this command from the root directory:\nmypy\nWe find that mypy is an enormous time-saver, catching many errors early and greatly reducing time spent debugging unit tests. However, note that mypy requires you type annotate every variable, function, and method in your code base, so taking advantage of it is a lifestyle change!\n\n\n\nIn line with the llms.txt standard, we have exposed the full Markdown-formatted project documentation as a single text file to make it more usable by LLM agents." |
120 | 141 | }, |
121 | 142 | { |
122 | 143 | "objectID": "docs/customization.html#development-workflow", |
123 | 144 | "href": "docs/customization.html#development-workflow", |
124 | 145 | "title": "Customization", |
125 | 146 | "section": "", |
126 | | - "text": "The project uses Poetry to manage dependencies:\n\nAdd new dependency: poetry add <dependency>\nAdd development dependency: poetry add --dev <dependency>\nRemove dependency: poetry remove <dependency>\nUpdate lock file: poetry lock\nInstall dependencies: poetry install\nUpdate all dependencies: poetry update\n\n\n\n\nThe project uses Pytest for unit testing. It’s highly recommended to write and run tests before committing code to ensure nothing is broken!\nThe following fixtures, defined in tests/conftest.py, are available in the test suite:\n\nengine: Creates a new SQLModel engine for the test database.\nset_up_database: Sets up the test database before running the test suite by dropping all tables and recreating them to ensure a clean state.\nsession: Provides a session for database operations in tests.\nclean_db: Cleans up the database tables before each test by deleting all entries in the PasswordResetToken and User tables.\nclient: Provides a TestClient instance with the session fixture, overriding the get_session dependency to use the test session.\ntest_user: Creates a test user in the database with a predefined name, email, and hashed password.\n\nTo run the tests, use these commands:\n\nRun all tests: pytest\nRun tests in debug mode (includes logs and print statements in console output): pytest -s\nRun particular test files by name: pytest <test_file_name>\nRun particular tests by name: pytest -k <test_name>\n\n\n\n\nThe project uses type annotations and mypy for static type checking. To run mypy, use this command from the root directory:\nmypy\nWe find that mypy is an enormous time-saver, catching many errors early and greatly reducing time spent debugging unit tests. However, note that mypy requires you type annotate every variable, function, and method in your code base, so taking advantage of it is a lifestyle change!" |
| 147 | + "text": "The project uses Poetry to manage dependencies:\n\nAdd new dependency: poetry add <dependency>\nAdd development dependency: poetry add --dev <dependency>\nRemove dependency: poetry remove <dependency>\nUpdate lock file: poetry lock\nInstall dependencies: poetry install\nUpdate all dependencies: poetry update\n\n\n\n\nThe project uses Pytest for unit testing. It’s highly recommended to write and run tests before committing code to ensure nothing is broken!\nThe following fixtures, defined in tests/conftest.py, are available in the test suite:\n\nengine: Creates a new SQLModel engine for the test database.\nset_up_database: Sets up the test database before running the test suite by dropping all tables and recreating them to ensure a clean state.\nsession: Provides a session for database operations in tests.\nclean_db: Cleans up the database tables before each test by deleting all entries in the PasswordResetToken and User tables.\nclient: Provides a TestClient instance with the session fixture, overriding the get_session dependency to use the test session.\ntest_user: Creates a test user in the database with a predefined name, email, and hashed password.\n\nTo run the tests, use these commands:\n\nRun all tests: pytest\nRun tests in debug mode (includes logs and print statements in console output): pytest -s\nRun particular test files by name: pytest <test_file_name>\nRun particular tests by name: pytest -k <test_name>\n\n\n\n\nThe project uses type annotations and mypy for static type checking. To run mypy, use this command from the root directory:\nmypy\nWe find that mypy is an enormous time-saver, catching many errors early and greatly reducing time spent debugging unit tests. However, note that mypy requires you type annotate every variable, function, and method in your code base, so taking advantage of it is a lifestyle change!\n\n\n\nIn line with the llms.txt standard, we have exposed the full Markdown-formatted project documentation as a single text file to make it more usable by LLM agents." |
127 | 148 | }, |
128 | 149 | { |
129 | 150 | "objectID": "docs/customization.html#project-structure", |
|
0 commit comments