fastapi-sqlmodel

(โ˜… 153)

FastAPI + SQLModel App Boilerplate

  • .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 Recommended
Prerequisites
  • 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

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
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