FastAPI and NiceGUI Full-Stack Template

This repository provides a template for building full-stack web applications using FastAPI for the backend and NiceGUI for the frontend. It includes a complete setup for a PostgreSQL database, JWT authentication, and a clean project structure, making it an excellent starting point for demos, prototypes, and internal tools.

Why FastAPI and NiceGUI?

Combining FastAPI and NiceGUI allows for the rapid development of web applications entirely in Python, which is a significant advantage for teams that want to avoid switching contexts between Python for the backend and JavaScript for the frontend.

• FastAPI is a modern, high-performance web framework for building APIs. It offers automatic interactive documentation, data validation powered by Pydantic, and an intuitive syntax that accelerates development.

• NiceGUI is a user-friendly, Python-based UI framework. It allows you to build web frontends without writing any HTML, CSS, or JavaScript. This is ideal for backend developers, data engineers, data scientists, and anyone who needs to create an interactive UI quickly.

This combination is perfect for demo applications because it enables a single developer to build and showcase a complete, interactive, and robust full-stack application in a fraction of the time it would take with traditional frameworks.

Features

• Modern Backend: A robust backend powered by FastAPI.
• Interactive Frontend: A simple and clean UI built with NiceGUI.
• Database Integration: PostgreSQL database managed with Docker and accessed using SQLModel.
• Authentication: JWT token-based security for API endpoints.
• Project Structure: A clear separation between backend and frontend source code.
• Automatic API Docs: Interactive API documentation available out-of-the-box.
• Containerized DB: Easy-to-manage PostgreSQL instance running in Docker.

Getting Started

Follow these instructions to get the project running on your local machine.

Prerequisites

• Python 3.10+
• Docker and Docker Compose
• Git

Setup Instructions

1. Clone the Repository

   git clone https://github.com/jaehyeon-kim/nicegui-fastapi-demo.git
   cd nicegui-fastapi-demo

2. Create and Activate a Virtual Environment

   # Create the virtual environment
   python -m venv venv
   
   # Activate it (on macOS/Linux)
   source venv/bin/activate
   
   # Or activate it (on Windows)
   .\venv\Scripts\activate

3. Install Dependencies

   pip install -r requirements.txt

4. Configure Environment Variables Create a .env file in the project root by copying the example file.

   cp .env.example .env

   You can modify the .env file if needed, but the default values are configured to work with the Docker Compose setup.

5. Start the PostgreSQL Database Run the following command to start the PostgreSQL database container in the background.

   docker-compose up -d

6. Run the Application Start the development server using Uvicorn. The --reload flag will automatically restart the server when you make code changes.

   uvicorn backend.main:app --reload

Accessing the Application

Once the server is running, you can access the following URLs:

Application Frontend: http://localhost:8000

• The main user interface built with NiceGUI.

API Docs (Swagger UI): http://localhost:8000/docs

• Interact with and test the API endpoints directly from your browser.

Alternate API Docs (ReDoc): http://localhost:8000/redoc

• View a clean and concise API documentation.

Stopping and Cleaning Up

When you are finished, you can stop the services and clean up the environment.

1. Stop the Uvicorn Server Press Ctrl+C in the terminal where the uvicorn command is running.

2. Stop the Database Container To stop the PostgreSQL container, run:

   docker-compose down

3. Deactivate the Virtual Environment

   deactivate

License

This project is licensed under the MIT License. See the LICENSE file for more details.