This updated architecture provides a more direct and cohesive way to build full-stack applications where the UI and backend logic are tightly coupled.

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-template.git
   cd nicegui-fastapi-demo
   

2. Create a Virtual Environment and Install Dependencies

   Choose one of the following methods:

   Option A: Using uv

   a. Install uv (if you haven't already)

   # On macOS/Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   
   # On Windows
   irm https://astral.sh/uv/install.ps1 | iex
   

   b. Create and Activate a Virtual Environment

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

   c. Install Dependencies

   uv pip install -r requirements.txt
   

   Option B: Using pip

   a. 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
   

   b. Install Dependencies

   pip install -r requirements.txt
   

3. 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.

4. Start the PostgreSQL Database

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

   docker-compose up -d
   

5. Run the Application Start the development server by executing the app.py script directly from your terminal.

   python app.py
   

   This command calls the ui.run() function at the bottom of the script, which starts the web server. Because the reload=True parameter is used, the server will automatically restart whenever you make code changes.

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 application 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.