https://github.com/fernandocelmer/cookiecutter-fastapi

❤️️ Amazing project with FastAPI
https://github.com/fernandocelmer/cookiecutter-fastapi

cookiecutter cookiecutter-fastapi cookiecutter-python cookiecutter-template fastapi fastapi-sqlalchemy fastapi-template pydantic python python-3 python3

Last synced: about 1 month ago
JSON representation

❤️️ Amazing project with FastAPI

• Host: GitHub
• URL: https://github.com/fernandocelmer/cookiecutter-fastapi
• Owner: FernandoCelmer
• License: mit
• Created: 2023-11-26T23:53:34.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-08T03:29:55.000Z (12 months ago)
• Last Synced: 2024-10-15T01:52:05.559Z (3 months ago)
• Topics: cookiecutter, cookiecutter-fastapi, cookiecutter-python, cookiecutter-template, fastapi, fastapi-sqlalchemy, fastapi-template, pydantic, python, python-3, python3
• Language: Python
• Homepage: https://fernandocelmer.github.io/cookiecutter-fastapi/
• Size: 433 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cookiecutter-fastapi

![GitHub forks](https://img.shields.io/github/forks/FernandoCelmer/cookiecutter-fastapi?label=Forks&style=flat-square)

![GitHub Repo stars](https://img.shields.io/github/stars/FernandoCelmer/cookiecutter-fastapi?label=Stars&style=flat-square)

![GitHub last commit](https://img.shields.io/github/last-commit/FernandoCelmer/cookiecutter-fastapi?style=flat-square)

- **Documentation**: [https://fernandocelmer.github.io/cookiecutter-fastapi](https://fernandocelmer.github.io/cookiecutter-fastapi)

- **Source Code**: [https://github.com/FernandoCelmer/cookiecutter-fastapi](https://github.com/FernandoCelmer/cookiecutter-fastapi)

## Features

- [x] For FastAPI 0.104.1

- [x] Works with Python 3.11

- [x] Config for Serverless

- [x] Config for MySQL/SQLlite

- [x] Async

- [x] Mkdocs

- [x] Basic Auth JWT

- [ ] Templates

- [ ] Crud

## Usage

First install cookiecutter

    pip install cookiecutter

Now run this command to clone

    cookiecutter https://github.com/FernandoCelmer/cookiecutter-fastapi

Now just fill in some information for the cookiecutter to do its work and replace it in the project.

    [1/18] repo_name (cookiecutter-fastapi): cookiecutter-fastapi

    [2/18] project_name (FastAPI Template): Test FastAPI 

    [3/18] project_slug (test_fastapi): 

    [4/18] description (Amazing project with FastAPI!): Amazing API

    [5/18] author_name (Fernando Celmer): Fernando Celmer

    [6/18] domain_name (fernandocelmer.com): fernandocelmer.com

    [7/18] email ([email protected]): [email protected]

    [8/18] version (0.1.0): 

    [9/18] Select open_source_license

        1 - MIT

        2 - BSD

        3 - Apache Software License 2.0

        4 - Not open source

        Choose from [1/2/3/4] (1): 1

    [10/18] Select id_type

        1 - UUID

        2 - Integer

        Choose from [1/2] (1): 1

    [11/18] url_documentation (#): 

    [12/18] url_source_code (#): 

    [13/18] use_async (y): 

    [14/18] use_mkdocs (y): 

    [15/18] use_serverless (y): 

    [16/18] use_templates (y): 

    [17/18] use_auth (y):

    [18/18] github_action_code_scan (y):

### Commit Style

- ⚙️ FEATURE

- 📝 PEP8

- 📌 ISSUE

- 🪲 BUG

- 📘 DOCS

- 📦 PyPI

- ❤️️ TEST

- ⬆️ CI/CD

- ⚠️ SECURITY

### License

This project is licensed under the terms of the **MIT** license.