-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Francisco Marques (tofran) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Python FastAPI HTMX full-text-search demo | ||
|
||
This project is a **demo** full-text-search application that leverages the power of | ||
[SQLite FT5](https://www.sqlite.org/fts5.html) and | ||
[Algolia SaaS](https://www.algolia.com/) to retrieve search results. | ||
|
||
Conceived as an experimental venture, this project serves as a demonstration of an *unconventional* | ||
monolith tech stack. It features an interactive front-end, using a mix of traditional | ||
Server Side Rendering (SSR) and zero custom JavaScript: | ||
|
||
- [FastAPI](https://fastapi.tiangolo.com/) the server framework; | ||
- [Jinja](https://jinja.palletsprojects.com/) for the SSR templating; | ||
- [HTMX](https://htmx.org/) to enable front-end interactivity in a declarative way. | ||
|
||
## Description and demo | ||
|
||
*So you don't have to spin up the project.* | ||
|
||
https://github.com/tofran/fastapi-htmx-full-text-search-demo/assets/5692603/43d642fd-52d5-4e5b-836a-6609d0c3d782 | ||
|
||
The outcome of this project is something very simple and minimal. The served content is **tiny** and | ||
**fast**. There's no initial loading, all is pre-rendered on the server and each API request renders | ||
HTML that is injected into the DOM - no need for Hydration, | ||
Resumability nor even data serialization. | ||
|
||
![OpenAPI spec (swagger)](https://github.com/tofran/fastapi-htmx-full-text-search-demo/assets/5692603/541f1f1a-fe1d-475c-8723-8f5a13e8f0df) | ||
|
||
The application works by serving a full rendered Jinja HTML template when the user navigates to a | ||
Front-End route. These templates are composed via smaller reusable templates (using `include`). | ||
And then I also serve these *components* de-coupled from the whole page in the *HTML API* | ||
(`/html-api/XXX`). HTMX handles the rest, replacing the content in the DOM when necessary. | ||
|
||
## Development | ||
|
||
- Create a `.env` file based on the `.env.template`. | ||
Your will need an Algolia account, should be pretty simple to setup to | ||
grab the App ID and API Key | ||
(more info in their | ||
[Quick start guide](https://www.algolia.com/doc/guides/getting-started/quick-start/) | ||
). | ||
|
||
- Setup a local environment with `make setup-venv`, | ||
activate it with `source ./venv/bin/activate`. | ||
|
||
- Install dependencies `make install-dev`. | ||
|
||
- Start the development server `make dev`. | ||
|
||
## Deployment | ||
|
||
For deployment the only difference is that you can skip the dev requirements with `make install` | ||
and run the application in a production ready server: `make start`. |