diff --git a/README.md b/README.md
index c266af6f..4b323779 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
-GitLink(确实开源)是CCF官方指定的开源创新服务平台,旨在以“为开源创新服务”为使命,以“成为开源创新的汇聚地”为愿景,秉承“创新、开放、协作、共享”的价值观,致力于为大规模开源开放协同创新助力赋能,打造创新成果孵化和新工科人才培养的开源创新生态!
+# GitLink - CCF开源创新服务平台
-
+GitLink(确实开源)是中国计算机学会(CCF)官方指定的开源创新服务平台,旨在以“为开源创新服务”为使命,以“成为开源创新的汇聚地”为愿景,秉承“创新、开放、协作、共享”的价值观,致力于为大规模开源开放协同创新助力赋能,打造创新成果孵化和新工科人才培养的开源创新生态!
+
+
+
+
## 特色功能
- **分布式协作开发**:基于Git打造分布式代码托管环境,提供免费公、私有代码仓库,支持在线文件编辑、代码分支管理、协作贡献统计、代码仓库复刻(Fork)、贡献合并请求(PR)、群智贡献审阅等功能,让您的项目在这里健康、快速的成长!
@@ -14,6 +18,9 @@ GitLink(确实开源)是CCF官方指定的开源创新服务平台,旨在
- **多维度用户画像**:实时采集和分析平台中的各类开源资源数据,搭建多维度用户画像评估系统,提供开发活动统计、贡献度日历、用户能力建模、角色与专业定位分析等功能,让您在个人主页展示开发动态与创新能力!
+## 第三方组件
+
+
## 部署流程
@@ -37,14 +44,11 @@ git clone -b standalone https://git.trustie.net/jasder/forgeplus.git
```
(2)安装依赖包
-
```bash
cd forgeplus && bundle install
```
-(3)配置初始化文件
-进入项目根目录执行一下命令:
-
+(3)配置初始化文件:进入项目根目录执行以下命令
```bash
cp config/configuration.yml.example config/configuration.yml
cp config/database.yml.example config/database.yml
@@ -52,11 +56,7 @@ touch config/redis.yml
touch config/elasticsearch.yml
```
-(4)配置数据库
-数据库配置信息请查看/config/database.yml文件,
-项目默认采用mysql数据库, 如需更改,请自行修改配置信息,
-默认配置如下:
-
+(4)配置数据库:数据库配置信息请查看/config/database.yml文件,项目默认采用mysql数据库, 如需更改,请自行修改配置信息,默认配置如下
```bash
default: &default
adapter: mysql2
@@ -66,14 +66,13 @@ default: &default
password: 123456
```
-(5)配置gitea服务(可选)
-**如需要部署自己的gitea平台,请参考gitea官方平台:https://docs.gitea.io/zh-cn/install-from-binary/**
+(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)进行部署
-**因目前gitea平台api受限,暂时推荐从forge平台获取gitea部署文件进行部署:https://forgeplus.trustie.net/projects/Trustie/gitea-binary**
-
-**配置gitea服务步骤**
-1)部署gitea服务,并注册root账户
-2)修改forge平台的 config/configuration.yml中的gitea服务指向地址,如:
+- 配置gitea服务步骤:
+
+ -- 部署gitea服务,并注册root账户
+
+ -- 修改forge平台的 config/configuration.yml中的gitea服务指向地址,如:
```ruby
gitea:
@@ -83,10 +82,9 @@ gitea:
base_url: '/api/v1'
```
-(6)安装redis环境
-**请自行搜索各平台如何安装部署redis环境**
+(6)安装redis环境:请自行搜索各平台如何安装部署redis环境
-(7)安装imagemagick插件
+(7)安装imagemagick插件:
- Mac OS X
```bash
brew install imagemagick ghostscript
@@ -97,8 +95,7 @@ gitea:
sudo apt-get install -y imagemagick
```
-(8)创建数据库
-**开发环境为development, 生成环境为production**
+(8)创建数据库:开发环境为development, 生成环境为production
```bash
rails db:create RAILS_ENV=development
```
@@ -109,14 +106,12 @@ rails db:create RAILS_ENV=development
bundle exec rake sync_table_structure:import_csv
```
-(10)执行migrate迁移文件
-**开发环境为development, 生成环境为production**
+(10)执行migrate迁移文件:开发环境为development, 生成环境为production
```bash
rails db:migrate RAILS_ENV=development
```
-(11)clone前端代码
-**将前端代码克隆到public/react目录下,目录结构应该是: public/react/build**
+(11)clone前端代码:将前端代码克隆到public/react目录下,目录结构应该是: public/react/build
```bash
git clone -b standalone https://git.trustie.net/jasder/build.git
```
@@ -126,8 +121,7 @@ git clone -b standalone https://git.trustie.net/jasder/build.git
redis-server&
```
-(13)启动sidekiq
-**开发环境为development, 生成环境为production**
+(13)启动sidekiq:开发环境为development, 生成环境为production
```bash
bundle exec sidekiq -C config/sidekiq.yml -e production -d
```
@@ -137,48 +131,59 @@ bundle exec sidekiq -C config/sidekiq.yml -e production -d
rails s
```
-(15)浏览器访问
-在浏览器中输入如下地址访问:
+(15)浏览器访问:在浏览器中输入如下地址访问
```bash
http://localhost:3000/
```
-(16)其他说明
-通过页面注册都第一个用户为平台管理员用户
+(16)其他说明:通过页面注册以第一个用户为平台管理员用户
+
## 页面展示
- 项目列表
-
-
+
+
+
+
- 代码仓库
-
-
-
+
+
+
+
+
- 任务管理
-
-
-
+
+
+
+
+
- 合并请求
-
-
-
+
+
+
+
+
- 引擎配置
+
+
+
+
-
-
-## API
-- [API文档](https://forgeplus.trustie.net/docs/api)
-- [API](showdoc.com.cn)
- 账号:forgeplus@admin.com 密码:forge123
## 贡献代码
+我们期待您向GitLink提交贡献!在您贡献时,请遵循以下流程:
+
1. Fork 项目
2. 创建本地分支(git checkout -b my-new-feature)
3. 提交更改 (git commit -am 'Add some feature')
4. 推送到分支 (git push origin my-new-feature)
5. 向源项目的 **develop** 分支发起 Pull Request
-## License
+#### 指导文档
+- [API文档](https://www.gitlink.org.cn/docs/api)
+- [Git常用命令](https://git-scm.com/)
+
+## 许可证协议