app-generator / fastapi-material-kit

FastAPI Material Kit - Open-Source Starter | AppSeed

FastAPI Material Kit

DESIGN Repo: https://github.com/creativetimofficial/material-kit

Product Roadmap

Status	Item	info
✅	Up-to-date Dependencies	-
✅	Material Kit	(Free Version) by Creative-Tim
✅	UI Kit	Bootstrap 5, Dark-Mode (persistent)
❌	Persistence	SQLite, MySql
✅	Basic Authentication	classic user/password
❌	API	Products & Sales (linked tables)
		GET Requests (public), get/, get/id
		Mutating requests (Create, UPD, DEL) (reserved for authenticated users)
✅	Docker	Simple Setup (local usage)
✅	OAuth	Github OAuth Provider
❌	Unitary tests	minimal suite

---

FastAPI Material Kit - Open-source Starter provided by AppSeed

1. create a virtual environment with python -m venv venv
2. activate the virtual environment, likely source venv/Scripts/active
3. install the requirements pip install -r requirements
4. uvicorn src.app:app

fastapi-material-kit's Issues

Feature Missing - Database Persistance

The readme suggests that there is a database being used in the project. However the auth we're using is github oauth, so we're not storing user data, or any data, unless I am mistaken.

Usability - ENV Default Values

Hello @barreraalexander

First, thank you for your work.

Regarding the product usability, the app should start without issues with zero effort if possible.
In order to achieve this, please use default values for all values expected in the environment:

GITHUB_CLIENT_ID    = None          # default
GITHUB_SECRET_KEY = None          # default

SECRET_KEY  = <random at start>  # default
ALGORITHM = <STRONG_crypto> # default 
ACCESS_TOKEN_EXPIRE_MINUTES= <2*60> # default 2hours
DEBUGGING=False                          # default 

Another suggestion is related to GH OAuth.
if the GH credentials are not provided by the user, the Social Login Button is hidden.

Please take a look.
Thank you!

Feature Missing - Unitary Tests

The readme specifies a set of unitary tests. I'm happy to build that out, however are you looking to test all of the UI routes? The auth routes are a given, I'll get to working on it now. Also, this problem ties into #3 , if we're going to have an API, I'll write up tests for those as well.

Feature Missing - API

The readme suggests that there is an API in the project, however we're only serving up a frontend route, and an authentication route. Unless I'm missing something!