# ai-friendly-coding

**Repository Path**: XuXiaoCong/ai-friendly-coding

## Basic Information

- **Project Name**: ai-friendly-coding
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-22
- **Last Updated**: 2026-03-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ai-friendly-coding

- 一个AI友好的Python后端框架，使开发者能够通过自然语言编码来构建应用程序

## 介绍

- 提供一个AI友好的Python框架
    - 可靠、易维护的Python后端框架
    - 匹配现代AI-IDE的文档集，通过自然语言编码来构建应用程序
    - 手动维护和扩展同样高效
- 前后端分离
    - 后端基于FastAPI
    - 前端（规划中）

## 环境及框架

- [Python 3.12+](https://www.python.org/downloads/)
- [FastAPI : API框架](https://fastapi.tiangolo.com/)
- [SQLModel : ORM](https://sqlmodel.tiangolo.com/)
- [Alembic : 数据库迁移工具](https://alembic.sqlalchemy.org/en/latest/)
- [Loguru : 日志库](https://loguru.readthedocs.io/en/stable/)

## 使用

- 下载代码

```bash
# Gitee
git clone https://gitee.com/XuXiaoCong/ai-friendly-coding.git
# GitHub
git clone https://github.com/xuxiaocong/ai-friendly-coding.git


cd ai-friendly-coding
```

- 安装依赖

```bash
# 使用uv安装
uv sync

# 使用pip安装
pip install -r requirements.txt
```

- 启动代码

```sh
# 复制环境变量配置文件
cp docker/.env.example .env

# 启动服务
uvicorn src.main:app --host 0.0.0.0 --port 8000 --reload
```