Merge pull request #74 from BUAA-SE-coders007/release

Alpha Release

Author: coder0xe

.env

@@ -0,0 +1,3 @@
+SECRET_KEY=bN3hZ6LbHG7nH9YXWULCr-crcS3GAaRELbNBdAyHBuiHH5TRctd0Zbd6OuLRHHa4Fbs
+SENDER_PASSWORD=TXVU2unpCAE2EtEX
+KIMI_API_KEY=sk-icdiHIiv6x8XjJCaN6J6Un7uoVxm6df5WPhflq10ZVFo03D9

.github/workflows/check.yml

@@ -0,0 +1,56 @@
+name: Check FastAPI Backend
+
+on:
+  pull_request:
+    branches:
+      - dev
+
+jobs:
+  test:
+    name: Run Tests and Check FastAPI
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_USER: test_user
+          POSTGRES_PASSWORD: test_password
+          POSTGRES_DB: test_db
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd="pg_isready -U test_user"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd="redis-cli ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Check FastAPI Server
+        run: |
+          uvicorn app.main:app --host 0.0.0.0 --port 8000 --log-level warning &
+          sleep 5
+          curl -f http://localhost:8000/docs

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy FastAPI Backend
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+
+jobs:
+  deploy:
+    name: Deploy to Server
+    runs-on: ubuntu-22.04
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v3
+
+    - name: Setup SSH
+      uses: webfactory/[email protected]
+      with:
+        ssh-private-key: ${{ secrets.SERVER_SSH_KEY }}
+
+    - name: Add server to known_hosts
+      run: |
+        ssh-keyscan -H jienote.top >> ~/.ssh/known_hosts
+
+    - name: Sync Code to Server
+      run: |
+        rsync -avz --delete \
+          --exclude '.git' \
+          --exclude '.github' \
+          ./ \
+          ${{ secrets.REMOTE_USER }}@${{ secrets.REMOTE_HOST }}:${{ secrets.REMOTE_PATH }}
+
+    - name: Build and Restart Docker on Server
+      run: |
+        ssh ${{ secrets.REMOTE_USER }}@${{ secrets.REMOTE_HOST }} << 'EOF'
+          cd ${{ secrets.REMOTE_PATH }}
+          cd ..
+          docker-compose down
+          docker-compose build
+          docker-compose up -d
+        EOF

.gitignore

@@ -0,0 +1,4 @@
+env
+__pycache__
+articles
+app.log

README.md

@@ -1,2 +1,117 @@
-# 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
+```
+
+## Redis
+- Redis is used for caching and session management.
+- Make sure to have Redis installed and running.
+
+```bash
+cd path/to/redis
+# Start Redis server
+redis-server.exe redis.windows.conf
+```
+Attention！！！
+- Make sure the port is not occupied by other services.
+- If you want to use the default port, please modify the `redis.windows.conf` file.
+- Must connect Redis before running the application. ‼️‼️‼️
+  
+
+## Token Authentication
+- JWT (JSON Web Token) is used for authentication.
+- Refresh tokens for 7 days and access tokens for 5min.
+
+## Folder Structure
+- `app/`: Contains the main application code.
+- `tests/`: Contains test cases.
+- `env/`: Virtual environment (not included in version control).
+
+## OCR 
+- Must install Poppler
+
+## 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.