.. FastAPI-Vue-template documentation master file, created by
   sphinx-quickstart on Tue Apr  1 21:27:18 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

FastAPI-Vue-template Documentation
===================================

Welcome to the **FastAPI-Vue-template** documentation! This project is a template for building modern web applications using **FastAPI** for the backend and **Vue.js** for the frontend. It provides a robust foundation for rapid development with features like authentication, API integration, and modular architecture.

Key Features
-------------
- **FastAPI Backend**: A high-performance Python web framework for building APIs.
- **Vue.js Frontend**: A progressive JavaScript framework for building user interfaces.
- **Authentication**: Pre-configured user authentication using FastAPI Users.
- **Modular Design**: Organized structure for scalable development.
- **Sphinx Documentation**: Auto-generated documentation for your project.

Getting Started
---------------
To get started with the project, refer to the following sections:

- **Installation**: Learn how to set up the project locally.
- **Backend**: Explore the FastAPI backend structure and APIs.
- **Frontend**: Understand the Vue.js frontend and its components.
- **Testing**: Learn how to run tests for both the backend and frontend.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

Additional Resources
--------------------
- **FastAPI Documentation**: https://fastapi.tiangolo.com/
- **Vue.js Documentation**: https://vuejs.org/
- **Sphinx Documentation**: https://www.sphinx-doc.org/