FastAPI-fastkit 1.0.0__tar.gz → 1.0.2__tar.gz

{fastapi_fastkit-1.0.0 → fastapi_fastkit-1.0.2}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 이준혁
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 이준혁
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_fastkit-1.0.2/PKG-INFO

@@ -0,0 +1,320 @@
+Metadata-Version: 2.1
+Name: FastAPI-fastkit
+Version: 1.0.2
+Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
+Author-Email: bnbong <bbbong9@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bnbong/FastAPI-kit
+Project-URL: Repository, https://github.com/bnbong/FastAPI-kit
+Project-URL: Documentation, https://bnbong.github.io/FastAPI-fastkit/
+Project-URL: Changelog, https://bnbong.github.io/FastAPI-fastkit/changelog/
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1.7
+Requires-Dist: rich>=13.9.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.3; extra == "dev"
+Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
+Requires-Dist: black>=24.10.0; extra == "dev"
+Requires-Dist: pre-commit>=4.0.1; extra == "dev"
+Requires-Dist: mypy>=1.12.0; extra == "dev"
+Requires-Dist: isort>=5.13.2; extra == "dev"
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
+</p>
+<p align="center">
+<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
+</a>
+<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
+</a>
+</p>
+
+---
+
+This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
+
+This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
+
+## Key Features
+
+- **Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin`feature of [Python Django](https://github.com/django/django)
+- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) feature)
+- **Standards-based FastAPI project template** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
+
+## Installation
+
+Install `FastAPI-fastkit` at your Python environment.
+
+```console
+$ pip install FastAPI-fastkit
+---> 100%
+```
+
+
+## Usage
+
+### Create a new FastAPI project workspace environment immediately
+
+You can now start new FastAPI project really fast with FastAPI-fastkit!
+
+Create a new FastAPI project workspace immediately with:
+
+```console
+$ fastkit init
+Enter the project name: my-awesome-project
+Enter the author name: John Doe
+Enter the author email: john@example.com
+Enter the project description: My awesome FastAPI project
+
+           Project Information
+┌──────────────┬────────────────────────────┐
+│ Project Name │ my-awesome-project         │
+│ Author       │ John Doe                   │
+│ Author Email │ john@example.com           │
+│ Description  │ My awesome FastAPI project │
+└──────────────┴────────────────────────────┘
+
+Available Stacks and Dependencies:
+           MINIMAL Stack
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ pydantic          │
+│ Dependency 4 │ pydantic-settings │
+└──────────────┴───────────────────┘
+
+           STANDARD Stack
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ sqlalchemy        │
+│ Dependency 4 │ alembic           │
+│ Dependency 5 │ pytest            │
+│ Dependency 6 │ pydantic          │
+│ Dependency 7 │ pydantic-settings │
+└──────────────┴───────────────────┘
+
+             FULL Stack
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ sqlalchemy        │
+│ Dependency 4 │ alembic           │
+│ Dependency 5 │ pytest            │
+│ Dependency 6 │ redis             │
+│ Dependency 7 │ celery            │
+│ Dependency 8 │ pydantic          │
+│ Dependency 9 │ pydantic-settings │
+└──────────────┴───────────────────┘
+
+Select stack (minimal, standard, full): minimal
+Do you want to proceed with project creation? [y/N]: y
+FastAPI project will deploy at '~your-project-path~'
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Injected metadata into setup.py                    │
+╰──────────────────────────────────────────────────────╯
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Injected metadata into config file                 │
+╰──────────────────────────────────────────────────────╯
+
+        Creating Project:
+       my-awesome-project
+┌───────────────────┬───────────┐
+│ Component         │ Collected │
+│ fastapi           │ ✓         │
+│ uvicorn           │ ✓         │
+│ pydantic          │ ✓         │
+│ pydantic-settings │ ✓         │
+└───────────────────┴───────────┘
+
+Creating virtual environment...
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ venv created at                                    │
+│ ~your-project-path~/my-awesome-project/.venv         │
+│ To activate the virtual environment, run:            │
+│                                                      │
+│     source                                           │
+│ ~your-project-path~/my-awesome-project/.venv/bin/act │
+│ ivate                                                │
+╰──────────────────────────────────────────────────────╯
+
+Installing dependencies...
+⠙ Setting up project environment...Collecting <packages~>
+
+---> 100%
+
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Dependencies installed successfully                │
+╰───────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ FastAPI project 'my-awesome-project' has been      │
+│ created successfully and saved to                     │
+│ ~your-project-path~!                                  │
+╰───────────────────────────────────────────────────────╯
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ To start your project, run 'fastkit runserver' at  │
+│ newly created FastAPI project directory              │
+╰──────────────────────────────────────────────────────╯
+```
+
+This command will create a new FastAPI project workspace environment with Python virtual environment.
+
+### Add a new route to the FastAPI project
+
+`FastAPI-fastkit` makes it easy to expand your FastAPI project.
+
+Add a new route endpoint to your FastAPI project with:
+
+```console
+$ fastkit addroute my-awesome-project user
+                       Adding New Route
+┌──────────────────┬──────────────────────────────────────────┐
+│ Project          │ my-awesome-project                       │
+│ Route Name       │ user                                     │
+│ Target Directory │ ~your-project-path~                      │
+└──────────────────┴──────────────────────────────────────────┘
+
+Do you want to add route 'user' to project 'my-awesome-project'? [Y/n]: y
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Updated main.py to include the API router          │
+╰──────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Successfully added new route 'user' to project     │
+│ `my-awesome-project`                                  │
+╰───────────────────────────────────────────────────────╯
+```
+
+### Place a structured FastAPI demo project immediately
+
+You can also start with a structured FastAPI demo project.
+
+Demo projects are consist of various tech stacks with simple item CRUD endpoints implemented.
+
+Place a structured FastAPI demo project immediately with:
+
+```console
+$ fastkit startdemo
+Enter the project name: my-awesome-demo
+Enter the author name: John Doe
+Enter the author email: john@example.com
+Enter the project description: My awesome FastAPI demo
+Deploying FastAPI project using 'fastapi-default' template
+Template path:
+/~fastapi_fastkit-package-path~/fastapi_project_template/fastapi-default
+
+           Project Information
+┌──────────────┬─────────────────────────┐
+│ Project Name │ my-awesome-demo         │
+│ Author       │ John Doe                │
+│ Author Email │ john@example.com        │
+│ Description  │ My awesome FastAPI demo │
+└──────────────┴─────────────────────────┘
+
+       Template Dependencies
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ pydantic          │
+│ Dependency 4 │ pydantic-settings │
+│ Dependency 5 │ python-dotenv     │
+└──────────────┴───────────────────┘
+
+Do you want to proceed with project creation? [y/N]: y
+FastAPI template project will deploy at '~your-project-path~'
+
+---> 100%
+
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Dependencies installed successfully                │
+╰───────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ FastAPI project 'my-awesome-demo' from             │
+│ 'fastapi-default' has been created and saved to       │
+│ ~your-project-path~!                                  │
+╰───────────────────────────────────────────────────────╯
+```
+
+To view the list of available FastAPI demos, check with:
+
+```console
+$ fastkit list-templates
+                      Available Templates
+┌─────────────────────────┬───────────────────────────────────┐
+│ fastapi-custom-response │ Async Item Management API with    │
+│                         │ Custom Response System            │
+│ fastapi-dockerized      │ Dockerized FastAPI Item           │
+│                         │ Management API                    │
+│ fastapi-empty           │ No description                    │
+│ fastapi-async-crud      │ Async Item Management API Server  │
+│ fastapi-psql-orm        │ Dockerized FastAPI Item           │
+│                         │ Management API with PostgreSQL    │
+│ fastapi-default         │ Simple FastAPI Project            │
+└─────────────────────────┴───────────────────────────────────┘
+```
+
+## Contributing
+
+We welcome contributions from the community! FastAPI-fastkit is designed to help newcomers to Python and FastAPI, and your contributions can make a significant impact.
+
+### For Contributors
+
+If you want to contribute to this project, we've made it easy to get started:
+
+1. **Quick Development Setup:**
+
+fork or clone this repository:
+
+   ```bash
+   git clone https://github.com/bnbong/FastAPI-fastkit.git
+   cd FastAPI-fastkit
+   make dev-setup
+   ```
+
+2. **Available Development Commands:**
+
+This project uses [Makefile](https://www.gnu.org/software/make/) to manage the development process.
+
+You can use the following commands to help you get started:
+
+   ```bash
+   make help  # See all available commands
+   make dev-check  # Run all checks before submitting
+   make quick-test  # Quick test after changes
+   ```
+
+3. **Read our contribution guidelines:**
+
+For other contribution guidelines, please refer to the following files:
+
+   - [CONTRIBUTING.md](CONTRIBUTING.md) - Detailed contribution guide
+   - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Project principles
+   - [SECURITY.md](SECURITY.md) - Security guidelines
+
+### What You Can Contribute
+
+- 🚀 **New FastAPI templates** - Add templates for different use cases
+- 🐛 **Bug fixes** - Help us improve stability and reliability
+- 📚 **Documentation** - Improve guides, examples, and translations
+- 🧪 **Tests** - Increase test coverage and add integration tests
+- 💡 **Features** - Suggest and implement new CLI features
+
+## Significance of FastAPI-fastkit
+
+FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
+
+This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
+
+As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/bnbong/FastAPI-fastkit/blob/main/LICENSE) file for details.

fastapi_fastkit-1.0.2/README.md

@@ -0,0 +1,298 @@
+<p align="center">
+    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
+</p>
+<p align="center">
+<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
+</a>
+<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
+</a>
+</p>
+
+---
+
+This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
+
+This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
+
+## Key Features
+
+- **Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin`feature of [Python Django](https://github.com/django/django)
+- **Prettier CLI outputs** : beautiful CLI experiment ([rich library](https://github.com/Textualize/rich) feature)
+- **Standards-based FastAPI project template** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use
+
+## Installation
+
+Install `FastAPI-fastkit` at your Python environment.
+
+```console
+$ pip install FastAPI-fastkit
+---> 100%
+```
+
+
+## Usage
+
+### Create a new FastAPI project workspace environment immediately
+
+You can now start new FastAPI project really fast with FastAPI-fastkit!
+
+Create a new FastAPI project workspace immediately with:
+
+```console
+$ fastkit init
+Enter the project name: my-awesome-project
+Enter the author name: John Doe
+Enter the author email: john@example.com
+Enter the project description: My awesome FastAPI project
+
+           Project Information
+┌──────────────┬────────────────────────────┐
+│ Project Name │ my-awesome-project         │
+│ Author       │ John Doe                   │
+│ Author Email │ john@example.com           │
+│ Description  │ My awesome FastAPI project │
+└──────────────┴────────────────────────────┘
+
+Available Stacks and Dependencies:
+           MINIMAL Stack
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ pydantic          │
+│ Dependency 4 │ pydantic-settings │
+└──────────────┴───────────────────┘
+
+           STANDARD Stack
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ sqlalchemy        │
+│ Dependency 4 │ alembic           │
+│ Dependency 5 │ pytest            │
+│ Dependency 6 │ pydantic          │
+│ Dependency 7 │ pydantic-settings │
+└──────────────┴───────────────────┘
+
+             FULL Stack
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ sqlalchemy        │
+│ Dependency 4 │ alembic           │
+│ Dependency 5 │ pytest            │
+│ Dependency 6 │ redis             │
+│ Dependency 7 │ celery            │
+│ Dependency 8 │ pydantic          │
+│ Dependency 9 │ pydantic-settings │
+└──────────────┴───────────────────┘
+
+Select stack (minimal, standard, full): minimal
+Do you want to proceed with project creation? [y/N]: y
+FastAPI project will deploy at '~your-project-path~'
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Injected metadata into setup.py                    │
+╰──────────────────────────────────────────────────────╯
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Injected metadata into config file                 │
+╰──────────────────────────────────────────────────────╯
+
+        Creating Project:
+       my-awesome-project
+┌───────────────────┬───────────┐
+│ Component         │ Collected │
+│ fastapi           │ ✓         │
+│ uvicorn           │ ✓         │
+│ pydantic          │ ✓         │
+│ pydantic-settings │ ✓         │
+└───────────────────┴───────────┘
+
+Creating virtual environment...
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ venv created at                                    │
+│ ~your-project-path~/my-awesome-project/.venv         │
+│ To activate the virtual environment, run:            │
+│                                                      │
+│     source                                           │
+│ ~your-project-path~/my-awesome-project/.venv/bin/act │
+│ ivate                                                │
+╰──────────────────────────────────────────────────────╯
+
+Installing dependencies...
+⠙ Setting up project environment...Collecting <packages~>
+
+---> 100%
+
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Dependencies installed successfully                │
+╰───────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ FastAPI project 'my-awesome-project' has been      │
+│ created successfully and saved to                     │
+│ ~your-project-path~!                                  │
+╰───────────────────────────────────────────────────────╯
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ To start your project, run 'fastkit runserver' at  │
+│ newly created FastAPI project directory              │
+╰──────────────────────────────────────────────────────╯
+```
+
+This command will create a new FastAPI project workspace environment with Python virtual environment.
+
+### Add a new route to the FastAPI project
+
+`FastAPI-fastkit` makes it easy to expand your FastAPI project.
+
+Add a new route endpoint to your FastAPI project with:
+
+```console
+$ fastkit addroute my-awesome-project user
+                       Adding New Route
+┌──────────────────┬──────────────────────────────────────────┐
+│ Project          │ my-awesome-project                       │
+│ Route Name       │ user                                     │
+│ Target Directory │ ~your-project-path~                      │
+└──────────────────┴──────────────────────────────────────────┘
+
+Do you want to add route 'user' to project 'my-awesome-project'? [Y/n]: y
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Updated main.py to include the API router          │
+╰──────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Successfully added new route 'user' to project     │
+│ `my-awesome-project`                                  │
+╰───────────────────────────────────────────────────────╯
+```
+
+### Place a structured FastAPI demo project immediately
+
+You can also start with a structured FastAPI demo project.
+
+Demo projects are consist of various tech stacks with simple item CRUD endpoints implemented.
+
+Place a structured FastAPI demo project immediately with:
+
+```console
+$ fastkit startdemo
+Enter the project name: my-awesome-demo
+Enter the author name: John Doe
+Enter the author email: john@example.com
+Enter the project description: My awesome FastAPI demo
+Deploying FastAPI project using 'fastapi-default' template
+Template path:
+/~fastapi_fastkit-package-path~/fastapi_project_template/fastapi-default
+
+           Project Information
+┌──────────────┬─────────────────────────┐
+│ Project Name │ my-awesome-demo         │
+│ Author       │ John Doe                │
+│ Author Email │ john@example.com        │
+│ Description  │ My awesome FastAPI demo │
+└──────────────┴─────────────────────────┘
+
+       Template Dependencies
+┌──────────────┬───────────────────┐
+│ Dependency 1 │ fastapi           │
+│ Dependency 2 │ uvicorn           │
+│ Dependency 3 │ pydantic          │
+│ Dependency 4 │ pydantic-settings │
+│ Dependency 5 │ python-dotenv     │
+└──────────────┴───────────────────┘
+
+Do you want to proceed with project creation? [y/N]: y
+FastAPI template project will deploy at '~your-project-path~'
+
+---> 100%
+
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Dependencies installed successfully                │
+╰───────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ FastAPI project 'my-awesome-demo' from             │
+│ 'fastapi-default' has been created and saved to       │
+│ ~your-project-path~!                                  │
+╰───────────────────────────────────────────────────────╯
+```
+
+To view the list of available FastAPI demos, check with:
+
+```console
+$ fastkit list-templates
+                      Available Templates
+┌─────────────────────────┬───────────────────────────────────┐
+│ fastapi-custom-response │ Async Item Management API with    │
+│                         │ Custom Response System            │
+│ fastapi-dockerized      │ Dockerized FastAPI Item           │
+│                         │ Management API                    │
+│ fastapi-empty           │ No description                    │
+│ fastapi-async-crud      │ Async Item Management API Server  │
+│ fastapi-psql-orm        │ Dockerized FastAPI Item           │
+│                         │ Management API with PostgreSQL    │
+│ fastapi-default         │ Simple FastAPI Project            │
+└─────────────────────────┴───────────────────────────────────┘
+```
+
+## Contributing
+
+We welcome contributions from the community! FastAPI-fastkit is designed to help newcomers to Python and FastAPI, and your contributions can make a significant impact.
+
+### For Contributors
+
+If you want to contribute to this project, we've made it easy to get started:
+
+1. **Quick Development Setup:**
+
+fork or clone this repository:
+
+   ```bash
+   git clone https://github.com/bnbong/FastAPI-fastkit.git
+   cd FastAPI-fastkit
+   make dev-setup
+   ```
+
+2. **Available Development Commands:**
+
+This project uses [Makefile](https://www.gnu.org/software/make/) to manage the development process.
+
+You can use the following commands to help you get started:
+
+   ```bash
+   make help  # See all available commands
+   make dev-check  # Run all checks before submitting
+   make quick-test  # Quick test after changes
+   ```
+
+3. **Read our contribution guidelines:**
+
+For other contribution guidelines, please refer to the following files:
+
+   - [CONTRIBUTING.md](CONTRIBUTING.md) - Detailed contribution guide
+   - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Project principles
+   - [SECURITY.md](SECURITY.md) - Security guidelines
+
+### What You Can Contribute
+
+- 🚀 **New FastAPI templates** - Add templates for different use cases
+- 🐛 **Bug fixes** - Help us improve stability and reliability
+- 📚 **Documentation** - Improve guides, examples, and translations
+- 🧪 **Tests** - Increase test coverage and add integration tests
+- 💡 **Features** - Suggest and implement new CLI features
+
+## Significance of FastAPI-fastkit
+
+FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
+
+This idea was initiated with the aim of full fill to help FastAPI newcomers to learn from the beginning, which is the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
+
+As one person who has been using and loving FastAPI for a long time, I wanted to develop a project that could help me a little bit to practice [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/bnbong/FastAPI-fastkit/blob/main/LICENSE) file for details.