(Translated by https://www.hiragana.jp/)
GitHub - rocboss/paopao-ce: 🔥An artistic "twitter like" community built on gin+zinc+vue+ts 清新文艺微社区
Skip to content

🔥An artistic "twitter like" community built on gin+zinc+vue+ts 清新せいしんぶん艺微しゃ

License

Notifications You must be signed in to change notification settings

rocboss/paopao-ce

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go Go Report Card Forks Stargazers MIT License Contributors Sourcegraph

Logo

PaoPao

🔥一个清新文艺的微社区
View Demo · Pull Request · Features


预览

Webはし
明色主题

暗色主题

さらえんじしめせ请前往かんからだ验(谢绝灌水)

桌面はし

(back to top)

🛠 わざ术栈

PaoPao主要しゅようよし以下いか优秀てき开源项目/工具こうぐ构建

きさきはし:

ぜんはし:

🏗 快速かいそく开始

环境要求ようきゅう

  • Go (1.20+)
  • Node.js (14+)
  • MySQL (5.7+)
  • Redis
  • Meilisearch

以上いじょう环境版本はんぽん为PaoPaoかんかたてき开发版本はんぽん,仅供参考さんこう,其他版本はんぽんてき环境进行充分じゅうぶん测试

あんそう说明

方式ほうしきいち. 动安そう(推荐)

かつたかしだい码库

git clone https://github.com/rocboss/paopao-ce.git

きさきはし

  1. 导入项目录下てき scripts/paopao.sql ぶんけんいたりMySQLすうすえ

  2. 拷贝项目录下 config.yaml.sample ぶんけんいたり config.yaml,按照ちゅう完成かんせい配置はいち编辑

  3. 编译きさきはし
    编译apiふく务:

    make build

    编译apiふく务、うちはまwebぜんはしui:

    make build

    也可以使用しようせい简模しき编译,うちはまwebぜんはしui:

    make build TAGS='slim embed'

    编译きさきざいrelease录可以找到对应行文こうぶんけん

    release/paopao
  4. 直接ちょくせつ运行きさきはし
    运行apiふく务:

    make run

    运行apiふく务、webぜんはしuiふく务:

    make run TAGS='embed'

    提示ていじ: 如果需要じゅようないはまwebぜんはしui,请先构建webぜんはし(けん议设おけweb/.env为VITE_HOST="")。

  5. 使用しようないおけてきMigrateつくえせい动升级维护SQL DDL:

    # 添加てんか Migration こうのういた Features ちゅう 开启migrateこうのう
    vim config.yaml
    # file: config.yaml
    # Features:
    #   Default: ["Base", "MySQL", "Zinc", "MinIO", "LoggerZinc", "Migration"]
    
    # 编译时加入かにゅうmigration tag编译支持しじmigrateこうのうてき行文こうぶんけん
    make build TAGS='migration'
    release/paopao
    
    # あるもの 带上migration tag直接ちょくせつ运行
    make run TAGS='migration'

    注意ちゅういだま认编译出来できてき行文こうぶんけんうちおけmigrateこうのう需要じゅよう编译时带じょうmigration tag才能さいのうないおけ支持しじmigrageこうのう

ぜんはし

  1. 进入ぜんはしweb,拷贝.env いた .env.local,编辑 .env.local ぶんけんちゅうきさきはしふく务地及其配置はいち项,しも载依赖包

    cd ./web && cp .env .env.local
    vim .env.local
    yarn
  2. 编译ぜんはし

    yarn build

    build完成かんせいきさき以在dist录获取编译产出,配置はいちnginx指向しこういたり该目录即

桌面はし

  1. 进入ぜんはしweb,拷贝.env いた .env.local,编辑 .env.local ぶんけんちゅうきさきはしふく务地及其配置はいち项,しも载依赖包

    cd ./web && cp .env .env.local
    vim .env.local
    yarn
  2. 编译ぜんはし

    yarn build
  3. 构建桌面はし

    yarn tauri build

    桌面はし使用しようRust + tauri编写 てき需要じゅようあんそうtauriてき赖,具体ぐたい参考さんこうhttps://tauri.studio/v1/guides/getting-started/prerequisites.

方式ほうしき. 使用しようDocker构建、运行

  • きさきはし:
# だま认参すう构建, だま认内はまweb ui并设おけapi host为空
docker build -t your/paopao-ce:tag .

# うちはまweb ui并且てい义API hostさんすう
docker build -t your/paopao-ce:tag --build-arg API_HOST=http://api.paopao.info .

# うちはまweb ui并且使用しよう本地ほんじweb/.envちゅうてきAPI host
docker build -t your/paopao-ce:tag --build-arg USE_API_HOST=no .

# うちはまweb ui并且使用しよう本地ほんじ编译てきweb/dist构建
docker build -t your/paopao-ce:tag --build-arg USE_DIST=yes .

# ただ编译api server
docker build -t your/paopao-ce:tag --build-arg EMBED_UI=no .

# 运行
mkdir custom && docker run -d -p 8008:8008 -v ${PWD}/custom:/app/paopao-ce/custom -v ${PWD}/config.yaml.sample:/app/paopao-ce/config.yaml your/paopao-ce:tag

# あるもの直接ちょくせつ运行构建このみてきdocker image
mkdir custom && docker run -d -p 8008:8008 -v ${PWD}/custom:/app/paopao-ce/custom -v ${PWD}/config.yaml.sample:/app/paopao-ce/config.yaml bitbus/paopao-ce:latest
  • ぜんはし:
cd web

# だま认参すう构建
docker build -t your/paopao-ce:web .

# てい义API host さんすう构建
docker build -t your/paopao-ce:web --build-arg API_HOST=http://api.paopao.info .

# 使用しよう本地ほんじ编译てきdist构建
docker build -t your/paopao-ce:web --build-arg USE_DIST=yes .

# 运行
docker run -d -p 8010:80 your/paopao-ce:web
  • All-In-One:
# 构建Image
docker buildx build --build-arg USE_DIST="yes" -t your/paopao-ce:all-in-one-latest -f Dockerfile.allinone .

# 运行
docker run --name paopao-ce-allinone  -d -p 8000:8008 -p 7700:7700 -v ./data/custom:/app/custom -v ./data/meili_data:/app/meili_data your/paopao-ce:all-in-one-latest

# あるもの使用しようかんかたImage运行
docker run --name paopao-ce-allinone  -d -p 8000:8008 -p 7700:7700 -v ./data/custom:/app/custom -v ./data/meili_data:/app/meili_data bitbus/paopao-ce:all-in-one-latest

# あるもの使用しようかんかたImage运行 + てい义config.yaml
docker run --name paopao-ce-allinone  -d -p 8000:8008 -p 7700:7700 -v ./config.yaml:/app/config.yaml -v ./data/custom:/app/custom -v ./data/meili_data:/app/meili_data bitbus/paopao-ce:all-in-one-latest

注意ちゅういざいconfig.yaml なかMeili.ApiKeyてき值必须与容器ようきちゅうmeili启动时设じょうてきMEILI_MASTER_KEY环境变量值相どうだま认为paopao-meilisearch. 以在docker启动容器ようき时通过-e MEILI_MASTER_KEY=<custom-key>设置该值。

方式ほうしきさん. 使用しよう docker-compose 运行

git clone https://github.com/rocboss/paopao-ce.git
cd paopao-ce && docker compose up -d
# visit http://localhost:8008  👀 paopao-ce
# visit http://localhost:8001  👀 RedisInsight
# visit http://localhost:8080  👀 phpMyAdmin

だま认是使用しようconfig.yaml.sampleてき配置はいち,如果需要じゅようてい配置はいち,请拷贝默认配置はいちぶんけん(如config.yaml),おさむあらためきさきさいどう配置はいちいたdocker-compose.yaml如下:

# file: docker-compose.yaml
...
  backend:
    image: bitbus/paopao-ce:latest
    restart: always
    depends_on:
      - db
      - redis
      - zinc
    # modify below to reflect your custom configure
    volumes:
      - ./config.yaml:/app/paopao-ce/config.yaml
    ports:
      - 8008:8008
    networks:
      - paopao-network
....

注意ちゅういだま提供ていきょうてき docker-compose.yaml はつ衷是搭建ほんつくえ开发调试环境,如果需要じゅよう产品部署ぶしょきょうがい网访问,请自ぎょう调优配置はいちさんすうある使用しよう其他方式ほうしき部署ぶしょ

开发ぶん

Docsぶん档说あきら

docs提供ていきょうりょうかく种开发文档,包括ほうかつ

  • deploy - paopao-ce部署ぶしょぶん
  • discuss - 开发しょう关的问题交流こうりゅう论述ぶん
  • openapi - paopao-ceきさきはし导出APIぶん
  • proposal - paopao-ceこうのう特性とくせいひさげ按文档

如,关于paopao-ceてき设计定位ていい参考さんこうdocs/proposal/001-关于paopao-ceてき设计定位ていい,简要阐述りょうpaopao-ce如何いか定位ていい自身じしんてき

APIぶん

开发しゃ以在本地ほんじ开启Docsふく务,浏览きさきはし导出てきAPIふく务接こうぶん档。

  • config.yaml 添加てんか Docs こうのう项:
...
Features:
  Default: ["Base", "MySQL", "Option", "LocalOSS", "LoggerFile", "Docs"]
  Docs: ["Docs:OpenAPI"]
...
  • 构建时将 docs 添加てんかいたTAGSちゅう:
make run TAGS='docs'

# visit http://127.0.0.1:8011/docs/openapi

配置はいち说明

config.yaml.sample 一份完整的配置文件模版,paopao-ce启动时会读取./custom/config.yaml./config.yaml任意にんい一份配置文件(优先读取さいさき找到てきぶんけん)。

cp config.yaml.sample config.yaml
vim config.yaml # おさむあらためさんすう
paopao serve

配置はいちぶんけんちゅうてき Features しょう节是声明せいめいpaopao-ce运行时开启哪些功のう项:

...

Features:
  Default: ["Base", "MySQL", "Option", "LocalOSS", "LoggerFile"]
  Develop: ["Base", "MySQL", "Option", "Sms", "AliOSS", "LoggerZinc"]
  Demo: ["Base", "MySQL", "Option", "Sms", "MinIO", "LoggerZinc"]
  Slim: ["Base", "Sqlite3", "LocalOSS", "LoggerFile"]
  Base: ["Zinc", "Redis", "Alipay",]
  Option: ["SimpleCacheIndex"]
  Sms: "SmsJuhe"

...

如上じょじょう: Default/Develop/Demo/Slim 不同ふどう こうのうしゅう套件(Features Suite), Base/Option こうのう套件, Sms关于短信たんしん验证码功のうてきまいりすう选项。

这里 Default套件 代表だいひょうてき意思いし使用しようBase/Option なかてきこうのうそと MySQL/LocalOSS/LoggerFileこうのう,也就说开启了Zinc/Redis/Alipay/SimpleCacheIndex/MySQL/LocalOSS/LoggerFile 7项功のうDevelop套件れい类推。

使用しようFeautures:

release/paopao serve --help
Usage of release/paopao:
  -features value
        use special features
  -no-default-features
        whether use default features

# だま使用しよう Default こうのう套件
release/paopao serve

# 包含ほうがん default ちゅうてきこうのうしゅう,仅仅使用しよう develop ちゅう声明せいめいてきこうのうしゅう
release/paopao serve --no-default-features --features develop 

# 使用しよう default ちゅうてきこうのうしゅうそと sms こうのう
release/paopao serve --features sms  

# 指定してい需要じゅよう开启てきこうのうしゅう
release/paopao serve --no-default-features --features sqlite3,localoss,loggerfile,redis 

目前もくぜん支持しじてきこうのう集合しゅうごう:

こうのう 类别 じょう 备注
Web ふく うち 开启Webふく
Admin ふく WIP 开启Adminきさきだい运维ふく
SpaceX ふく WIP 开启SpaceXふく
Bot ふく WIP 开启Botふく
NativeOBS ふく WIP 开启NativeOBSふく
Docs ふく WIP 开启开发しゃぶん档服务
Frontend:Web ふく 稳定 开启独立どくりつぜんはしふく
Frontend:EmbedWeb ふく 稳定 开启ないはま于后はしWeb APIふく务中てき前端ぜんたんふく
Gorm かずすえ 稳定(だま认) 使用しようgormさく为数すえ库的ORM,だま使用しよう Gorm + MySQL组合
Sqlx かずすえ WIP 使用しようsqlxさく为数すえ库的ORM
Sqlc かずすえ WIP 使用しようsqlc生成せいせいORMだい
MySQL かずすえ 稳定(だま认) 使用しようMySQLさく为数すえ
Postgres かずすえ 稳定 使用しようPostgreSQLさく为数すえ
Sqlite3 かずすえ 稳定 使用しようSqlite3さく为数すえ
AliOSS 对象そん 稳定(推荐) おもねさとうん对象そん储服务
COS 对象そん うち 腾讯うん对象そん储服务
HuaweiOBS 对象そん うち 华为うん对象そん储服务
MinIO 对象そん 稳定 MinIO对象そん储服务
S3 对象そん うち AWS S3けんようてき对象そん储服务
LocalOSS 对象そん うち 提供ていきょう使用しようほん地目ちもく录文けんさく为对ぞうそん储的こうのう,仅用于开发调试环さかい
OSS:Retention 对象そん うち もと于对ぞうそん储系统的对象过期动删じょ特性とくせい实现 さき创建临时对象さい持久じきゅうてきこうのう
OSS:TempDir 对象そん うち もと于对ぞうそん储系统的对象拷贝/うつり动特せい实现 さき创建临时对象さい持久じきゅうてきこうのう
Redis 缓存 稳定 Redis缓存こうのう
SimpleCacheIndex 缓存 Deprecated 提供ていきょう简单てき 广场推文れつひょう てき缓存こうのう
BigCacheIndex 缓存 Deprecated 使用しようBigCache缓存 广场推文れつひょう,缓存ごと个用户每いち页,简单做到せんにんせんめん
RedisCacheIndex 缓存 Deprecated 使用しようRedis缓存 广场推文れつひょう,缓存ごと个用户每いち页,简单做到せんにんせんめん
Zinc 搜索そうさく 稳定(推荐) もとZinc搜索そうさく引擎提供ていきょう推文搜索そうさくふく
Meili 搜索そうさく 稳定(推荐) もとMeilisearch搜索そうさく引擎提供ていきょう推文搜索そうさくふく
Bleve 搜索そうさく WIP もとBleve搜索そうさく引擎提供ていきょう推文搜索そうさくふく
Sentry 监控 うち 使用しようSentry进行错误跟踪与性能せいのう监控
LoggerFile にちこころざし 稳定 使用しようぶんけんうつしこころざし
LoggerZinc にちこころざし 稳定(推荐) 使用しようZincうつしこころざし
LoggerMeili にちこころざし うち 使用しようMeilisearchうつしこころざし
LoggerOpenObserve にちこころざし うち 使用しようOpenObserveうつしこころざし
Friendship 关系しき うちおけ Builtin じゃく关系こうともしき,类似ほろしん朋友ほうゆうけん
Followship 关系しき うちおけ Builtin 关注しゃしき,类似TwitterてきFollowしき
Lightship 关系しき 弃用 Deprecated 开放しき所有しょゆう推文おおやけ开可见
Alipay ささえづけ 稳定 开启もとささえづけたから开放平台ひらだいてき钱包こうのう
Sms 短信たんしん验证 稳定 开启短信たんしん验证码功のうよう于手つくえ绑定验证しゅつくえいなちゅうさつしゃてきこうのう如果ぼつゆう开启,つくえ绑定时任意にんい短信たんしん验证码都以绑じょうしゅつくえ
Docs:OpenAPI 开发ぶん 稳定 开启openapiぶん档功のう提供ていきょうweb apiぶん档说あきら(visit http://127.0.0.1:8008/docs/openapi)
Pyroscope 性能せいのう优化 うち 开启Pyroscopeこうのうよう性能せいのう调试
Pprof 性能せいのう优化 うち 开启Pprofこうのう收集しゅうしゅうProfileしんいき
PhoneBind 其他 稳定 つくえ绑定こうのう
UseAuditHook 其他 うち 使用しよう审核hookこうのう
DisableJobManager 其他 うち 禁止きんし使用しようJobManagerこうのう
Web:DisallowUserRegister こうのう特性とくせい 稳定 まこと许用户注さつ

こうのう项状态详じょう参考さんこう features-status.

搭建赖环さかい

Zinc 搜索そうさく引擎:

  • Zinc运行
# 创建よう于存zincすうすえてき
mkdir -p data/zinc/data

# 使用しようDocker运行zinc
docker run -d --name zinc --user root -v ${PWD}/data/zinc/data:/data -p 4080:4080 -e ZINC_FIRST_ADMIN_USER=admin -e ZINC_FIRST_ADMIN_PASSWORD=admin -e DATA_PATH=/data public.ecr.aws/zinclabs/zinc:latest

# 查看zinc运行じょう
docker ps
CONTAINER ID   IMAGE                                COMMAND                  CREATED        STATUS        PORTS                    NAMES
41465feea2ff   getmeili/meilisearch:v0.27.0         "tini -- /bin/sh -c …"   20 hours ago   Up 20 hours   0.0.0.0:7700->7700/tcp   paopao-ce-meili-1
7daf982ca062   public.ecr.aws/prabhat/zinc:latest   "/go/bin/zinc"           3 weeks ago    Up 6 days     0.0.0.0:4080->4080/tcp   zinc

# 使用しようdocker compose运行
docker compose up -d zinc
# visit http://localhost:4080 开自带的ui管理かんり界面かいめん
  • おさむあらためZinc配置はいち
# featuresちゅうじょう Zinc  LoggerZinc
Features:
  Default: ["Zinc", "LoggerZinc", "Base", "Sqlite3", "BigCacheIndex","MinIO"]
...
LoggerZinc: # 使用しようZincうつしこころざし
  Host: 127.0.0.1:4080  # 这里てきhost就是paopao-ceのう访问到てきzincぬしつくえ
  Index: paopao-log
  User: admin
  Password: admin
  Secure: False         # 如果使用しようhttps访问zinc就设おけ为True
...
Zinc: # Zinc搜索そうさく配置はいち
  Host: 127.0.0.1:4080
  Index: paopao-data
  User: admin
  Password: admin
  Secure: False

Meilisearch 搜索そうさく引擎:

  • Meili运行
mkdir -p data/meili/data

# 使用しようDocker运行
docker run -d --name meili -v ${PWD}/data/meili/data:/meili_data -p 7700:7700 -e MEILI_MASTER_KEY=paopao-meilisearch getmeili/meilisearch:v0.29.0
# visit http://localhost:7700 开自带的搜索そうさくぜんはしui

# 使用しようdocker compose运行,需要じゅよう删除docker-compose.yamlちゅう关于meiliてきちゅう
docker compose up -d meili

# 查看meili运行じょう
docker compose ps
NAME                   COMMAND                  SERVICE             STATUS              PORTS
paopao-ce-meili-1      "tini -- /bin/sh -c …"   meili               running             0.0.0.0:7700->7700/tcp
  • おさむあらためMeili配置はいち
# featuresちゅうじょう Meili  LoggerMeili
Features:
  Default: ["Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex","MinIO"]
...
LoggerMeili: # 使用しようMeiliうつしこころざし
  Host: 127.0.0.1:7700
  Index: paopao-log
  ApiKey: paopao-meilisearch
  Secure: False
  MinWorker: 5               # 最小さいしょうきさきだい工作こうさくしゃ, 设置范围[5, 100], だま认5
  MaxLogBuffer: 100          # 最大さいだいlog缓存じょうすう, 设置范围[10, 10000], だま认100
...
Meili: # Meili搜索そうさく配置はいち
  Host: 127.0.0.1:7700      # 这里てきhost就是paopao-ceのう访问到てきmeiliぬしつくえ
  Index: paopao-data
  ApiKey: paopao-meilisearch
  Secure: False             # 如果使用しようhttps访问meili就设おけ为True

MinIO 对象そん储服务

  • MinIO运行
mkdir -p data/minio/data

# 使用しようDocker运行
docker run -d --name minio -v ${PWD}/data/minio/data:/data -p 9000:9000 -p 9001:9001 -e MINIO_ROOT_USER=minio-root-user -e  MINIO_ROOT_PASSWORD=minio-root-password -e MINIO_DEFAULT_BUCKETS=paopao:public bitnami/minio:latest

# 使用しようdocker compose运行, 需要じゅよう删除docker-compose.yamlちゅう关于minioてきちゅう
docker compose up -d minio
  • おさむあらためMinio配置はいち
# featuresちゅうじょう MinIO
Features:
  Default: ["MinIO", "Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex"]
...
MinIO: # MinIO そん配置はいち
  AccessKey: Q3AM3UQ867SPQQA43P2F      # AccessKey/SecretKey 需要じゅようとうにゅうminio管理かんり界面かいめんしゅ动创けん管理かんり界面かいめん: http://127.0.0.1:9001
  SecretKey: zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG
  Secure: False
  Endpoint: 127.0.0.1:9000             # すえ部署ぶしょてきminioぬしつくえおさむあらため对应
  Bucket: paopao                       # 如上じょじょう需要じゅようざい管理かんり界面かいめん创建bucket并赋外部がいぶ读写权限
  Domain: 127.0.0.1:9000               # minioがい网访问的(如果そう让外网访问,这里需要じゅよう设置为外网可访问到てきminioぬしつくえ)
...

OpenObserve にちこころざし收集しゅうしゅうゆび标度りょう、轨迹跟踪

  • OpenObserve运行
# 使用しようDocker运行
mkdir data && docker run -v $PWD/data:/data -e ZO_DATA_DIR="/data" -p 5080:5080 \
    -e ZO_ROOT_USER_EMAIL="root@paopao.info" -e ZO_ROOT_USER_PASSWORD="paopao-ce" \
    public.ecr.aws/zinclabs/openobserve:latest

# 使用しようdocker compose运行, 需要じゅよう删除docker-compose.yamlちゅう关于openobserveてきちゅう
docker compose up -d openobserve
# visit http://loclahost:5080
  • おさむあらためLoggerOpenObserve配置はいち
# featuresちゅうじょう LoggerOpenObserve
Features:
  Default: ["Meili", "LoggerOpenObserve", "Base", "Sqlite3", "BigCacheIndex"]
...
LoggerOpenObserve: # 使用しようOpenObserveうつしこころざし
  Host: 127.0.0.1:5080
  Organization: paopao-ce
  Stream: default
  User: root@paopao.info
  Password: tiFEI8UeJWuYA7kN
  Secure: False
...

Pyroscope 性能せいのう剖析

  • Pyroscope运行
mkdir -p data/minio/data

# 使用しようDocker运行
docker run -it -p 4040:4040 pyroscope/pyroscope:latest server
# 使用しようdocker compose运行, 需要じゅよう删除docker-compose.yamlちゅう关于pyroscopeてきちゅう
docker compose up -d pyroscope
# visit http://loclahost:4040
  • おさむあらためPyroscope配置はいち
# featuresちゅうじょう Pyroscope
Features:
  Default: ["Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex", "Pyroscope"]
...
Pyroscope: # Pyroscope配置はいち
  AppName: "paopao-ce"
  Endpoint: "http://localhost:4040"   # Pyroscope server address
  AuthToken:                          # Pyroscope authentication token
  Logger:  none                       # Pyroscope logger (standard | logrus | none)
...

みなもとだい码分ささえ管理かんり

おもだい码库github.com/rocboss/paopao-ce

git branch
main
beta
dev
feature/bleve
feature/followship
feature/mir
feature/localoss
jc/alimy
r/paopao-plus
r/paopao-pro
x/sqlc
x/sqlx

ぶんささえ说明

名称めいしょう 说明 备注
main おもぶんささえ ぶんささえmainぬしぶんささえ,也是paopao-ceてき稳定版本はんぽん发布ぶんささえただゆう经过内部ないぶ测试,ぼつゆう重大じゅうだいbug现的稳定だい码才かい推进到这个ぶんささえ;该分ささえ主要しゅようゆかりbetaぶんささえだい码演进而らいはら则上ただ接受せつじゅbugおさむ复PRrc版本はんぽん/稳定版本はんぽん 发布应该ざいmainおもぶんささえちゅう进行。
beta おおやけ测分ささえ ぶんささえbetaこう测分ささえだい码推进到mainおもぶんささえてきこう选分ささえ;该分ささえ主要しゅようゆかりalphaぶんささえだい码演进而らい接受せつじゅbugおさむ复以及新こうのう优化てきPRはら则上接受せつじゅしんこうのうPR。beta版本はんぽん 发布应该ざいbetaおおやけ测分ささえ进行。
alpha うち测分ささえ ぶんささえalphaない测分ささえだい码推进到betaぶんささえてきこう选分ささえ;该分ささえ主要しゅようゆかりdevぶんささえだい码演进而らい接受せつじゅbugおさむ复以及新こうのうしょう关的PR接受せつじゅしんこうのうPR。ぶんささえだい码演进到一个里程碑式的阶段后冻结所有しょゆうしんこうのうごう并代码到betaおおやけ测分ささえ进行一阶段的持续演进。alpha版本はんぽん 发布应该ざいalphaうち测分ささえ进行。
dev 开发ぶんささえ ぶんささえdev开发ぶんささえ不定期ふていき频繁更新こうしん接受せつじゅ しんこうのうPR、だい码优PR、bugおさむ复PRしんこうのうPR 应该くびさきつつみ交给devぶんささえ进行あい并,bugおさむ复/しんこうのう开发/だい码优 阶段せい冻结 きさきしょうだい码演进合并到alphaぶんささえ
feature/* こうのうぶんささえ feature/*しんこうのう子分こぶんささえ,一般新功能子分支都是 dev开发ぶんささえfork出来できてきこうのうぶんささえ ただ专注于该しんこうのう だい码的开发/优化,まち开发接近せっきんない测阶だん ひさげ交新こうのうPR给devぶんささえ进行review/mergeまちしんこう能代のしろ码演进到betaぶんささえきさきはら则上以删じょ该分ささえただし也可以保留ほりゅういた稳定版本はんぽん发布。该分ささえ专注于新こうのうてき开发,ただ接受せつじゅしんこうのうてきbugおさむ复/优化PR
jc/* 维护しゃてき开发ぶんささえ jc/*だい码库维护しゃてき开发ぶんささえ,一般包含一些局部优化或者bugおさむ复代码,ゆう时可以直接ちょくせつはただい码mergeいたdev/betaぶんささえはら则上まこと直接ちょくせつmergeだい码到mainおもぶんささえ
x/* 实验ぶんささえ x/*わざ术实验分ささえぼう些技术的引入需要じゅよう经过具体ぐたいてきだい码实现与实场けいてき测评,考量こうりょう评估きさき如果ぼう项技术适あい引入いたpaopao-ce,就forkいちfeature/*ぶんささえさく为新こうのう引入いたpaopao-ce。一般いっぱん一些比较激进的技术,从devぶんささえforkいち个新てきx/*ぶんささえかく种尝试、考量こうりょう、评估きさきある丢弃、ある引入いたpaopao-ce。
t/* 临时ぶんささえ t/*临时发版本分ほんぶんささえ一般いっぱん beta ぶんささええんじ进到正式せいしき版本はんぽん发布まえてきさいきさきぼう个beta版本はんぽん如v0.2.0-beta)就从betaぶんささえforkいちt/* ぶんささえよう于向 main ぶんささえひさげ交 PR よう于Review,まち PR Reviewed あい并到 main ぶんささえきさき以删じょ这个临时创建てきぶんささえ。这样设计主要しゅようこう虑到ゆう时合并到 main ぶんささえ时,需要じゅようReviewてき时间可能かのうかい长一些,而devぶんささえてきだい码又きゅう需推进到betaぶんささえ以发布下ぬのしたいち个alpha版本はんぽんよう于内测,相当そうとう于为一个测试版本发布腾地方。
r/* 发行ばん本分ほんぶんささえ r/*不同ふどう发行ばん本分ほんぶんささえ不同ふどう发行版本はんぽんかくゆう不同ふどうてき侧重てん以根すえ需要じゅよう选择适合てき发行版本はんぽん

发行ばん本分ほんぶんささえ说明

名称めいしょう 说明 维护しゃ 备注
paopao-ce paopao-ce しゅ发行版本はんぽん ROC 该分ささえ かずすえ逻辑层 使用しようgormさく为数すえ逻辑层的ORMかまち,适配MySQL/PostgreSQL/Sqlite3すうすえ库。
r/paopao-ce paopao-ce ぬしぶんささえ预览版本はんぽん ROC
北野きたの
该分ささえ かずすえ逻辑层 使用しようgormさく为数すえ逻辑层的ORMかまち,适配MySQL/PostgreSQL/Sqlite3すうすえ库。だい码较mainぶんささえしんぬし发行版本はんぽんてきぜん瞻预览版本はんぽん
r/paopao-ce-plus paopao-ce-plus 发行版本はんぽん 北野きたの 该分ささえ かずすえ逻辑层 使用しようsqlxさく为数すえ逻辑层的ORMかまち,专注于为MySQL/PostgreSQL/Sqlite3使用しようさら优化てき查询语句以提ますすうすえ检索效率こうりつけん议熟悉sqlxてき开发じん员可以基于此ばん本来ほんらい开发。
r/paopao-ce-pro paopao-ce-pro 发行版本はんぽん 北野きたの 该分ささえ かずすえ逻辑层 使用しようsqlcさく为sql语句生成せいせい生成せいせいORMだい码,专门针对特定とくていすうすえ库MySQL/PostgreSQL进行查询优化,じゅくsqlcてき开发じん员可以基于此ばん本来ほんらい开发。(另:ぶんささえ目前もくぜんただ使用しようpgx-v5适配りょうPostgreSQLすうすえ库,きさき续或许会适配MySQL/TiDBすうすえ库。)
r/paopao-ce-xtra paopao-ce-xtra 发行版本はんぽん 北野きたの 该分ささえ r/paopao-ce、r/paopao-ce-plus、r/paopao-ce-proてきごうしゅう
r/paopao-ce-mini paopao-ce-mini 发行版本はんぽん 北野きたの 该分ささえpaopao-ce最小さいしょう可用かよう版本はんぽん,专注于个じん部署ぶしょ、一键傻瓜式最简部署

だい码分ささええんじ进图

部署ぶしょ站点しんいき

具体ぐたい部署ぶしょ站点しんいき请查阅 deployed-sites. 欢迎站长はたやめ部署ぶしょPaoPao实例てき站点しんいき添加てんかいた deployed-sites れつひょうちゅう

Collaborator's paopao account

昵称 @GitHub @PaoPao
ROC ROC ROC
北野きたの Michael Li alimy
orzi! orzi!

其他说明

けん议后はしふく使用しよう supervisor まもり护进ほど,并通过 nginx はんこう代理だいりきさき提供ていきょうAPI给前はしふく务调よう

短信たんしんどおりどう使用しようてき聚合すうすえ,如果さる请不らい以考虑替换其ふく务商。

だい码结构比较简单,很方便びん扩展,开发ぶん档请さんdocs.

👯‍♀️ 贡献

paopao-ce いち利用りよう 业余时间 ほんちゃく "Just for fun just do it." てきこころもち续有じょ 开发/优化/维护てき开源项目,ぼつゆうKPIこうかくぼつゆうRoadmap进度压力、ぼつゆうわざ支持しじ日程にっていやすはいある许有些许不足ふそく处,ただし是重これしげざい精神せいしんよしみ借用しゃくよう网络ちゅうてき"F*k talk, f*k of tech innovation, Shut up and show me your code." 一切都因更好的体验,一切都是为了爱好,一切都在代码里;期待きたいろう铁们加入かにゅう一起かずき开发、一起かずきおり腾、一起かずきかい乐。

欢的朋友ほうゆう记得给个Star,欢迎贡献PR。

Star History Chart

License

Distributed under the MIT License. See LICENSE for more information.