create-api-app 2.0.1

A quickstart tool for creating a FastAPI project with a NextJS frontend.

Create API App Quickstart Tool

Welcome to the quickstart tool for creating a FastAPI project with a NextJS frontend.

This tool is intended to be dynamic and installs the most recent packages where possible, while maintaining compatibility across the main OS's (Mac, Linux and Windows). You can use the tool by installing the PIP package. See the Using The Tool section for more details.

If there are any issues using the tool, please flag them in the issues section of this repository.

Found on:

• PyPi
• GitHub

Why This Tool?

Creating a project from scratch can be a tedious process. Not only do you have to create all the files yourself, it typically requires a lot of small minor changes that can easily be automated. So, rather than wasting a lot of time setting up projects, I created a tool that does it all for me!

I use this tool personally for SaaS and ML API projects and have found it extremely useful for immediately diving into coding without faffing around with setup details (except for configuring API keys). Hopefully, it's useful to you too!

The Stack

All projects are created using the same stack, consisting of the following:

1. Backend

   • FastAPI
   • MongoDB
   • Beanie
   • Poetry
   • Pytest
   • Hypothesis

2. Frontend

   • NextJS
   • TailwindCSS
   • Uploadthing
   • Clerk
   • Stripe
   • Lucide React
   • Shadcn UI

Note: all libraries and packages are automatically installed to their latest versions when running the tool.

Useful Styling Options

• Clerk Themes
• Shadcn UI Theme Generator
• Modern Background Snippets

Using The Tool

1. Firstly, install Docker, we use this to create the frontend files dynamically using the Build NextJS App Tool.

2. Install the package through PIP using the following command (requires Python 3.12 minimum):

   pip install create_api_app
   

3. Create a project with the following command:

   create-api-app <project_name>
   

And that's it! You'll find two folders in your project, one called frontend (for NextJS) and another called backend (for FastAPI).