Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmitrytokyo/fastapi_session_auth
Fastapi draft project with session bases auth. Using htmx
https://github.com/dmitrytokyo/fastapi_session_auth
admin-dashboard authentication authorization fastapi htmx session sqlalchemy
Last synced: 7 days ago
JSON representation
Fastapi draft project with session bases auth. Using htmx
- Host: GitHub
- URL: https://github.com/dmitrytokyo/fastapi_session_auth
- Owner: DmitryTokyo
- Created: 2024-06-09T10:18:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T15:40:59.000Z (8 months ago)
- Last Synced: 2024-11-29T04:14:57.845Z (2 months ago)
- Topics: admin-dashboard, authentication, authorization, fastapi, htmx, session, sqlalchemy
- Language: Python
- Homepage:
- Size: 248 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# FastAPI Template Project with Session Authentication, Jinja2, and HTMX
This project serves as a template for creating web applications using FastAPI, Jinja2 templates, and HTMX for dynamic interactions. The goal is to provide a ready-to-use framework that includes session-based authentication, admin interface with authentication, unit tests for CRUD operations and main routes, and Docker support. This allows developers to focus on implementing their specific logic without worrying about the underlying infrastructure and services.
## Features
- Session-based authentication
- SQLAlchemy admin with authentication
- Unit tests for CRUD operations and main routes
- Dockerfile for containerization
## Environment Variables
- `SECRET_KEY`: A secret key for securing the session data.
- `DB_URL`: The database URL in a format understood by SQLAlchemy. For example, `postgres://user:password@localhost/dbname`. More details can be found [here](https://pypi.org/project/dj-database-url/).
- `DEV`: Specifies the environment. Possible values are `Dev`, `Test`, `Prod`, or any other custom environment you might add.
## Running Tests
All tests use SQLite for the database (it is created locally). To run the unit tests for CRUD operations and main routes, use the following command:
```shell
make tests
```
## Usage
### In the local machine
You can start application by command:
```shell
make runserver
```
### Using Docker
At first, you need to create a `.env` file in the root directory of your project with the following variables:
```plaintext
SECRET_KEY=your_secret_key
DB_URL=your_database_url
DEV=True
POSTGRES_USER=your_postgres_user
POSTGRES_PASSWORD=your_postgres_password
POSTGRES_DB=your_postgres_db
```
1. Use bash script (docker-compose inside)
```shell
chmod +x run.sh
```
and then
```shell
./run.sh
```
2. Use Docker CLI
```shell
docker build -t fastapi-app:latest .
docker run -d -p 8000:5000 fastapi-app
```
## Interactive Shell
You can interact with the objects and application logic using an IPython shell. To start the IPython shell, use the following command:
```shell
make ipython
```