https://github.com/squidmin/fastapi-template

FastAPI server template
https://github.com/squidmin/fastapi-template

fastapi fastapi-template pytest python python3

Last synced: 9 days ago
JSON representation

FastAPI server template

• Host: GitHub
• URL: https://github.com/squidmin/fastapi-template
• Owner: squidmin
• Created: 2024-03-20T20:53:22.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-24T20:28:02.000Z (6 months ago)
• Last Synced: 2024-10-12T22:58:53.781Z (24 days ago)
• Topics: fastapi, fastapi-template, pytest, python, python3
• Language: Python
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# fastapi-template

FastAPI server template.

## Installation

### 1. Install Python

You can install Python using `pyenv` on macOS or Linux. On Windows, you can use `pyenv-win`.

### 2. Install dependencies

You can install the dependencies using `pip` and the `requirements.txt` and `requirements-test.txt` files.

```shell

pip install -r requirements.txt

```

```shell

pip install -r requirements-test.txt

```

### 3. Run the application

You can run the application using `uvicorn`.

```shell

uvicorn main:app --reload

```

The `--reload` flag enables hot reloading so the server will automatically reload when you make changes to your code.

You should see output indicating that the server is running, typically on `http://127.0.0.1:8000`.

### View docs

View API documentation at http://127.0.0.1:8000/docs#/.