fastapi-sqlmodel
FastAPI + SQLModel App Boilerplate
File Explorer
Download Latest Version (.zip)- python-app.yml
- __init__.py
- crud.py
- models.py
- views.py
- crud.py
- models.py
- views.py
- crud.py
- models.py
- views.py
- __init__.py
- generic_models.py
- logger.py
- mock_data_generator.py
- app.py
- config.py
- database.py
- SQLModel.png
- SQLModelAPI_openapi.png
- common.yaml
- test_hero.tavern.yaml
- test_team.tavern.yaml
- .env.example
- .gitignore
- asgi.py
- Dockerfile
- entrypoint.sh
- LICENSE
- Pipfile
- Pipfile.lock
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/anthonycepeda/fastapi-sqlmodel
Downloads the entire project code from GitHub to your computer.
cd fastapi-sqlmodel
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
`docker build -t sqlmodel-api:latest . && docker run -p 8080:8080 sqlmodel-api:latest`
Builds a runnable image based on the Dockerfile.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pipenv install
Type this command into your terminal and run it.
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)