template-test3/README.md

template-test3

This repo create with FastAPI and Vue 3, powered by freeleaps.com.

Please do not delete files under ${PROJECT_ROOT}/.freeleaps, these files used to supports DevOps workflow.

Project Layout

├── .freeleaps/              # Freeleaps configuration
│   ├── devops/             # DevOps related configurations
│   └── project.yaml        # Project configuration file
├── app/                    # FastAPI backend application
│   ├── modules/            # Application modules
│   │   ├── sys/           # System related modules
│   │   └── __init__.py    # Module initialization
│   ├── utils/             # Utility functions
│   ├── routes.py          # API route definitions
│   ├── schema.py          # Pydantic schemas
│   └── setup_app.py       # Application setup and configuration
├── web/                    # Vue 3 frontend application
│   ├── src/               # Source code
│   │   ├── assets/        # Static assets
│   │   ├── components/    # Vue components
│   │   ├── router/        # Vue router configuration
│   │   ├── stores/        # Pinia stores
│   │   ├── views/         # Page views
│   │   ├── App.vue        # Root Vue component
│   │   └── main.ts        # Application entry point
│   ├── public/            # Public static files
│   ├── e2e/              # End-to-end tests
│   ├── package.json       # Node.js dependencies
│   ├── vite.config.ts     # Vite configuration
│   ├── tsconfig.json      # TypeScript configuration
│   └── README.md          # Frontend specific documentation
├── main.py                 # FastAPI application entry point
├── requirements.txt        # Python dependencies
├── .env.example           # Environment variables template
├── .gitignore             # Git ignore rules
└── README.md              # This file

Backend (FastAPI)

• main.py: Application entry point and server startup
• app/: Contains all backend application code
  • modules/: Feature-based modules organization
  • routes.py: API endpoint definitions
  • schema.py: Data validation schemas using Pydantic
  • setup_app.py: Application configuration and middleware setup
  • utils/: Shared utility functions

Frontend (Vue 3)

• web/: Complete Vue 3 application with TypeScript
  • src/: Source code with modern Vue 3 composition API
  • components/: Reusable Vue components
  • views/: Page-level components
  • router/: Client-side routing configuration
  • stores/: State management using Pinia
  • assets/: Static assets like images, styles
• Vite: Fast build tool and development server
• TypeScript: Type-safe JavaScript development
• ESLint & Prettier: Code linting and formatting

Configuration

• .freeleaps/: Platform-specific configurations
• .env.example: Environment variables template
• requirements.txt: Python package dependencies
• package.json: Node.js dependencies and scripts