https://github.com/devroopsaha744/fastapi-scaffold
FastAPI Scaffold is a CLI tool to quickly generate FastAPI project structures with optional features like authentication, database integration, machine learning model setup, and Docker support.
https://github.com/devroopsaha744/fastapi-scaffold
auth backend-development cli db docker docker-compose fastapi project-management python
Last synced: 4 months ago
JSON representation
FastAPI Scaffold is a CLI tool to quickly generate FastAPI project structures with optional features like authentication, database integration, machine learning model setup, and Docker support.
- Host: GitHub
- URL: https://github.com/devroopsaha744/fastapi-scaffold
- Owner: devroopsaha744
- License: mit
- Created: 2025-03-11T11:23:08.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-11T11:25:24.000Z (4 months ago)
- Last Synced: 2025-03-11T12:28:50.750Z (4 months ago)
- Topics: auth, backend-development, cli, db, docker, docker-compose, fastapi, project-management, python
- Language: Python
- Homepage: https://pypi.org/project/fastapi-scaffold/0.1.0/
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastAPI Scaffold
[](https://pypi.org/project/fastapi-scaffold/)
[](https://www.python.org/)
[](LICENSE)
FastAPI Scaffold is a CLI tool to quickly generate FastAPI project structures with optional features like authentication, database integration, machine learning model setup, and Docker support.
## Installation
To install FastAPI Scaffold, run:
```sh
pip install fastapi-scaffold
```
## Usage
To create a new FastAPI project, use the following command:
```sh
fastapi-scaffold create my_project
```
This will generate a basic FastAPI project structure inside the `my_project` directory.
### Options
You can customize the generated project using the following flags:
```sh
fastapi-scaffold create my_project --ml --db --auth --docker
```
- `--ml` → Includes boilerplate for integrating ML models
- `--db` → Adds database configuration and ORM setup
- `--auth` → Includes authentication (OAuth, JWT, etc.)
- `--docker` → Generates a `Dockerfile` and `docker-compose.yml`
## Project Structure
A generated FastAPI project will follow this structure:
```
my_project/
│── app/
│ ├── main.py
│ ├── routes/
│ ├── models/
│ ├── services/
│ ├── db.py (if --db is used)
│ ├── auth.py (if --auth is used)
│── tests/
│── .env
│── Dockerfile (if --docker is used)
│── requirements.txt
│── README.md
```
## Running the Project
After creating the project, navigate to your project directory and install dependencies:
```sh
cd my_project
pip install -r requirements.txt
```
Then, start the FastAPI application:
```sh
uvicorn app.main:app --reload
```
The API will be available at [http://127.0.0.1:8000](http://127.0.0.1:8000).
## Contributing
Contributions are welcome! If you find a bug or want to request a feature, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.