chore: prepare initial open-source release

Author: CodingFeng101

.dockerignore

@@ -0,0 +1,33 @@
+.git
+.github
+.gitignore
+.gitattributes
+.idea
+.vscode
+.trae
+.venv
+__pycache__
+*.pyc
+*.pyo
+.run-logs
+*.log
+*.sqlite3
+*.db
+*.key
+*.pem
+*.pfx
+**/password.txt
+.env
+.env.*
+!.env.docker.example
+!backend/.env.template
+frontend/node_modules
+frontend/dist
+frontend/dist-ssr
+backend/log
+backend/temp_files
+temp_files
+embedding/web_data_embeddings
+backend/static/*
+!backend/static/default
+!backend/static/default/**

.env.docker.example

@@ -0,0 +1,38 @@
+ENVIRONMENT=dev
+TZ=Asia/Shanghai
+
+MYSQL_USER=root
+MYSQL_PASSWORD=replace-with-a-strong-mysql-password
+MYSQL_DATABASE=onlineunigraph
+MYSQL_EXPOSE_PORT=3306
+
+REDIS_PASSWORD=replace-with-a-strong-redis-password
+REDIS_DATABASE=0
+REDIS_EXPOSE_PORT=6379
+
+BACKEND_PORT=8000
+FRONTEND_PORT=8080
+
+TOKEN_SECRET_KEY=replace-with-a-random-token-secret
+OPERA_LOG_ENCRYPT_SECRET_KEY=replace-with-a-random-opera-log-secret
+JXNU_AES_SECRET_KEY=
+
+OAUTH2_GITHUB_CLIENT_ID=test
+OAUTH2_GITHUB_CLIENT_SECRET=test
+OAUTH2_LINUX_DO_CLIENT_ID=test
+OAUTH2_LINUX_DO_CLIENT_SECRET=test
+
+CELERY_BROKER_REDIS_DATABASE=1
+CELERY_BACKEND_REDIS_DATABASE=2
+
+EMBEDDING_MODEL=text-embedding-3-small
+OPENAI_API_KEY=replace-with-your-embedding-api-key
+
+SSO_USER_INFO_URL=http://backend:8000/knowg/v1/sys/users/me
+INDEX_EXPORT_URL_ROOT=http://backend:8000/knowg/v1/knowledge/ask
+CORS_ALLOWED_ORIGINS=["http://localhost:8080"]
+
+FRONTEND_VITE_HOST_URL=
+FRONTEND_VITE_API_BASE_URL=/knowg
+FRONTEND_VITE_SHOW_IMAGE_API=/knowg/v1/image/
+FRONTEND_VITE_USER_INFO_SSO_URL=/knowg/v1/sys/users/me

.gitattributes

@@ -0,0 +1,33 @@
+* text=auto
+
+*.py text eol=lf
+*.js text eol=lf
+*.ts text eol=lf
+*.vue text eol=lf
+*.css text eol=lf
+*.html text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.txt text eol=lf
+*.toml text eol=lf
+*.conf text eol=lf
+*.sql text eol=lf
+*.sh text eol=lf
+*.yml text eol=lf
+*.yaml text eol=lf
+Dockerfile* text eol=lf
+.dockerignore text eol=lf
+.gitattributes text eol=lf
+.gitignore text eol=lf
+
+*.cmd text eol=crlf
+*.ps1 text eol=crlf
+
+*.ico binary
+*.jpg binary
+*.jpeg binary
+*.png binary
+*.svg text eol=lf
+*.ttf binary
+*.woff binary
+*.woff2 binary

.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: /backend
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: npm
+    directory: /frontend
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  backend:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install backend quality tools
+        run: python -m pip install ruff==0.15.20 -r backend/requirements.txt
+      - name: Check Python formatting and lint
+        working-directory: backend
+        run: |
+          ruff format --check .
+          ruff check .
+      - name: Run security regression tests
+        run: |
+          python -m unittest discover -s backend/tests -v
+          python backend/tests/smoke_import.py
+      - name: Audit locked backend dependencies
+        run: |
+          python -m pip install pip-audit
+          pip-audit --requirement backend/requirements.txt --no-deps --disable-pip
+
+  frontend:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: frontend
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: npm
+          cache-dependency-path: frontend/package-lock.json
+      - run: npm ci
+      - run: npm run typecheck
+      - run: npm run build
+      - run: npm audit --audit-level=high
+
+  compose:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Validate Compose configuration
+        run: docker compose --env-file .env.docker.example config --quiet

.gitignore

@@ -0,0 +1,59 @@
+.DS_Store
+Thumbs.db
+
+.idea/
+.vscode/
+.trae/
+.codex-release-git/
+
+.venv/
+venv/
+__pycache__/
+*.py[cod]
+*.pyo
+
+.run-logs/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+*.log
+
+frontend/node_modules/
+frontend/dist/
+frontend/dist-ssr/
+frontend/.vite/
+
+backend/log/*
+backend/temp_files/*
+!backend/temp_files/.gitkeep
+temp_files/*
+!temp_files/.gitkeep
+backend/static/*
+!backend/static/.gitkeep
+!backend/static/default/
+!backend/static/default/**
+embedding/web_data_embeddings/*
+!embedding/web_data_embeddings/.gitkeep
+backend/embedding/web_data_embeddings/
+backend/common/core_layer/unigraph/web_search/web_data_embeddings/
+backend/ip2region.xdb
+*.sqlite3
+*.db
+
+# Never commit private keys or bundled certificate archives.
+*.key
+*.pem
+*.pfx
+**/password.txt
+
+.env.docker
+.env
+.env.*
+!.env.template
+!.env.docker.example
+backend/.env
+backend/.env.*
+!backend/.env.template
+*.local

.python-version

@@ -0,0 +1 @@
+3.11

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+Thanks for improving UniGraph.
+
+## Development workflow
+
+1. Fork the repository and create a focused branch.
+2. Keep changes small and explain the problem they solve.
+3. Never commit `.env` files, credentials, logs, database files, generated
+   assets, or user data.
+4. Run the checks below before opening a pull request.
+
+```bash
+ruff format --check backend
+ruff check backend
+python -m unittest discover -s backend/tests -v
+python backend/tests/smoke_import.py
+pip-audit --requirement backend/requirements.txt --no-deps --disable-pip
+cd frontend
+npm ci
+npm run lint
+npm run typecheck
+npm run build
+npm audit --audit-level=high
+```
+
+For backend changes, add focused tests when a test seam exists. Avoid broad
+format-only changes in the same pull request as functional work.
+
+## Pull requests
+
+Describe the behavior before and after the change, how it was verified, and
+any migration or configuration impact. Link the relevant issue when one
+exists.

Dockerfile.backend

@@ -0,0 +1,20 @@
+FROM python:3.11-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PYTHONPATH=/app
+
+WORKDIR /app
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends gcc python3-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY backend/requirements.txt /tmp/requirements.txt
+RUN pip install --no-cache-dir -r /tmp/requirements.txt
+
+COPY backend /app/backend
+
+EXPOSE 8000
+
+CMD ["uvicorn", "backend.main:app", "--host", "0.0.0.0", "--port", "8000"]

Dockerfile.celery

@@ -0,0 +1,18 @@
+FROM python:3.11-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PYTHONPATH=/app
+
+WORKDIR /app
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends gcc python3-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY backend/requirements.txt /tmp/requirements.txt
+RUN pip install --no-cache-dir -r /tmp/requirements.txt
+
+COPY backend /app/backend
+
+CMD ["celery", "-A", "backend.app.task.celery:celery_app", "worker", "--loglevel=info"]