From 4144128cd14f1d12c2e4c3f4b63decb6c9aa99e0 Mon Sep 17 00:00:00 2001 From: young Date: Mon, 6 Dec 2021 11:16:52 +0800 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 89e6955e..c266af6f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ GitLink（确实开源）是CCF官方指定的开源创新服务平台，旨在 ![](https://code.gitlink.org.cn/young/forgeplus/raw/branch/standalone/docs/figs/gitlink.png?raw=true) -## 1.特色功能 +## 特色功能 - **分布式协作开发**：基于Git打造分布式代码托管环境，提供免费公、私有代码仓库，支持在线文件编辑、代码分支管理、协作贡献统计、代码仓库复刻（Fork）、贡献合并请求（PR）、群智贡献审阅等功能，让您的项目在这里健康、快速的成长！ @@ -14,7 +14,7 @@ GitLink（确实开源）是CCF官方指定的开源创新服务平台，旨在 - **多维度用户画像**：实时采集和分析平台中的各类开源资源数据，搭建多维度用户画像评估系统，提供开发活动统计、贡献度日历、用户能力建模、角色与专业定位分析等功能，让您在个人主页展示开发动态与创新能力！ -## 2.部署流程 +## 部署流程 ### 依赖库 @@ -31,18 +31,18 @@ GitLink（确实开源）是CCF官方指定的开源创新服务平台，旨在 ### 步骤 -#### （1）克隆稳定版本 +（1）克隆稳定版本 ``` git clone -b standalone https://git.trustie.net/jasder/forgeplus.git ``` -#### （2）安装依赖包 +（2）安装依赖包 ```bash cd forgeplus && bundle install ``` -#### （3）配置初始化文件 +（3）配置初始化文件 进入项目根目录执行一下命令： ```bash @@ -52,7 +52,7 @@ touch config/redis.yml touch config/elasticsearch.yml ``` -#### （4）配置数据库 +（4）配置数据库 数据库配置信息请查看/config/database.yml文件， 项目默认采用mysql数据库, 如需更改，请自行修改配置信息， 默认配置如下： @@ -66,7 +66,7 @@ default: &default password: 123456 ``` -#### （5）配置gitea服务(可选) +（5）配置gitea服务(可选) **如需要部署自己的gitea平台，请参考gitea官方平台：https://docs.gitea.io/zh-cn/install-from-binary/** **因目前gitea平台api受限，暂时推荐从forge平台获取gitea部署文件进行部署：https://forgeplus.trustie.net/projects/Trustie/gitea-binary** @@ -83,10 +83,10 @@ gitea: base_url: '/api/v1' ``` -#### （6）安装redis环境 +（6）安装redis环境 **请自行搜索各平台如何安装部署redis环境** -#### （7）安装imagemagick插件 +（7）安装imagemagick插件 - Mac OS X ```bash brew install imagemagick ghostscript @@ -97,74 +97,74 @@ gitea: sudo apt-get install -y imagemagick ``` -#### （8）创建数据库 +（8）创建数据库 **开发环境为development， 生成环境为production** ```bash rails db:create RAILS_ENV=development ``` -#### （9）导入数据表结构 +（9）导入数据表结构 ```bash bundle exec rake sync_table_structure:import_csv ``` -#### （10）执行migrate迁移文件 +（10）执行migrate迁移文件 **开发环境为development， 生成环境为production** ```bash rails db:migrate RAILS_ENV=development ``` -#### （11）clone前端代码 +（11）clone前端代码 **将前端代码克隆到public/react目录下，目录结构应该是: public/react/build** ```bash git clone -b standalone https://git.trustie.net/jasder/build.git ``` -#### （12）启动redis(此处以macOS系统为例) +（12）启动redis(此处以macOS系统为例) ```bash redis-server& ``` -#### （13）启动sidekiq +（13）启动sidekiq **开发环境为development， 生成环境为production** ```bash bundle exec sidekiq -C config/sidekiq.yml -e production -d ``` -#### （14）启动rails服务 +（14）启动rails服务 ```bash rails s ``` -#### （15）浏览器访问 +（15）浏览器访问 在浏览器中输入如下地址访问： ```bash http://localhost:3000/ ``` -#### （16）其他说明 +（16）其他说明 通过页面注册都第一个用户为平台管理员用户 ## 页面展示 -### 项目列表 +- 项目列表 ![](https://code.gitlink.org.cn/young/forgeplus/raw/branch/standalone/docs/figs/project_list.png?raw=true) -### 代码仓库 +- 代码仓库 ![](https://code.gitlink.org.cn/young/forgeplus/raw/branch/standalone/docs/figs/repo.png?raw=true) -### 任务管理 +- 任务管理 ![](https://code.gitlink.org.cn/young/forgeplus/raw/branch/standalone/docs/figs/issues.png?raw=true) -### 合并请求 +- 合并请求 ![](https://code.gitlink.org.cn/young/forgeplus/raw/branch/standalone/docs/figs/PR.png?raw=true) -### 引擎配置 +- 引擎配置 ![](https://code.gitlink.org.cn/young/forgeplus/raw/branch/standalone/docs/figs/engine.png?raw=true)