[init]: 初始化项目结构

Author: Fantasylee21

.github/workflows/main.yml

@@ -0,0 +1,49 @@
+name: Python Code Linting (Safe Optimized)
+
+on:
+  # 触发条件 1: 所有分支的 push 事件
+  push:
+    branches-ignore: []  
+
+  # 触发条件 2: 针对 dev 分支的 pull_request 事件
+  pull_request:
+    branches: [ "dev" ]  
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code (with full history)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2  # 必须获取前一次提交，才能比较变更
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install flake8
+        run: pip install flake8
+
+      - name: Get valid changed Python files
+        id: changed-files
+        run: |
+          # 获取变更的.py文件列表，并过滤出实际存在的文件
+          FILES=$(git diff --name-only --diff-filter=d HEAD^ HEAD | grep '\.py$' | while read -r file; do 
+            [ -f "$file" ] && echo "$file"
+          done)
+          
+          echo "Valid changed Python files:"
+          echo "$FILES"
+          echo "files=${FILES}" >> $GITHUB_OUTPUT
+
+      - name: Run flake8 on changed files
+        if: steps.changed-files.outputs.files != ''
+        run: |
+          
+          echo "${{ steps.changed-files.outputs.files }}" | xargs -r flake8
+
+      - name: Skip if no valid Python files changed
+        if: steps.changed-files.outputs.files == ''
+        run: echo "✅ 没有有效的.py文件变更，跳过检查"

.gitignore

@@ -0,0 +1,2 @@
+env
+__pycache__

README.md

@@ -1,2 +1,95 @@
-# JieNote_backend
-2025春季软件工程课程团队项目JieNote项目后端
+# JieNote Backend
+
+This is the backend service for JieNote, built with FastAPI.
+
+## Features
+- RESTful API endpoints
+- Modular structure for scalability
+
+## File Structure
+- `app/`: Contains the main application code.
+  - `main.py`: Entry point for the FastAPI application.
+  - `models/`: Database models and schemas.
+  - `core/`: Core configurations and settings.
+    - include database settings
+    - include JWT settings
+    - include CORS settings
+    - ……
+  - `curd/`: CRUD operations for database interactions.
+  - `db/`: Database connection and session management.
+  - `schemas/`: Pydantic schemas for data validation.
+  - `static/`: Static files (e.g., images, CSS).
+  - `routers/`: API route definitions.
+- `tests/`: Contains test cases for the application.
+- `requirements.txt`: List of dependencies.
+- `README.md`: Documentation for the project.
+- `alembic/`: Database migration scripts and configurations.
+- `env/`: Virtual environment (not included in version control).
+- `img/`: Images used in the project.
+
+## Setup
+1. Create a virtual environment: ✔
+   ```bash
+   python -m venv env
+   ```
+2. Activate the virtual environment: 
+   - On Windows:
+     ```bash
+     .\env\Scripts\activate
+     ```
+   - On macOS/Linux:
+     ```bash
+     source env/bin/activate
+     ```
+3. Install dependencies: 
+   ```bash
+   pip install -r requirements.txt
+   ```
+4. freeze requirements(do before commit !!!): 
+   ```bash
+   pip freeze > requirements.txt
+   ```
+
+## Database Migration
+<!-- 数据库迁移使用alembic -->
+1. Install Alembic: ✔
+   ```bash
+   pip install alembic
+   ```
+2. Initialize Alembic: ✔
+   ```bash
+   alembic init alembic
+   ```
+3. Configure Alembic: ✔
+
+   1. Edit `alembic.ini` to set the database URL.
+   2. Edit `alembic/env.py` to set up the target metadata. 
+      ```python
+      from app.models import Base  # Import your models here
+      target_metadata = Base.metadata
+      ```
+4. Create a migration script: need to modify the script
+   ```bash
+   alembic revision --autogenerate -m "提交信息"
+   ```
+5. Apply the migration: need to modify the script
+   ```bash
+   alembic upgrade head
+   ```
+
+
+## Run the Application
+```bash
+uvicorn app.main:app --reload
+```
+
+## Folder Structure
+- `app/`: Contains the main application code.
+- `tests/`: Contains test cases.
+- `env/`: Virtual environment (not included in version control).
+
+## ER Diagram
+![ER Diagram](img/er_diagram.jpg)
+
+## License
+MIT License

alembic.ini

@@ -0,0 +1,119 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = mysql+pymysql://root:[email protected]:3306/JieNote
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

alembic/env.py

@@ -0,0 +1,79 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+from app.db.base import Base
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = Base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

alembic/script.py.mako

@@ -0,0 +1,28 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    ${downgrades if downgrades else "pass"}