mirror of
https://github.com/PGYER/codefever.git
synced 2026-06-03 07:32:14 +08:00
Carney Wu
21
README.md
21
README.md
@@ -47,7 +47,7 @@
|
||||
|
||||
英文版本文档正在完善中, 欢迎 [提交文档](doc/zh-cn/contribute/doc_pr.md)
|
||||
|
||||
[English](doc/en-us/start/welcome.md)
|
||||
[English](README_EN.md)
|
||||
|
||||
<details open>
|
||||
<summary><b>目录</b></summary>
|
||||
@@ -88,14 +88,15 @@
|
||||
|
||||
### **如何安装**
|
||||
|
||||
`CodeFever` 提供 `从头开始安装` 和 `Docker 镜像安装` 两种安装方式，可以根据自己的实际需要选择安装方式。
|
||||
`CodeFever` 提供 `从零开始安装` 和 `Docker 镜像安装` 两种安装方式，可以根据自己的实际需要选择安装方式。
|
||||
|
||||
- **(推荐)** 最简单的安装方式是使用 `Docker`，只需要一行命令即可完成，具体可见： [Docker 镜像安装](doc/zh-cn/installation/install_via_docker.md)
|
||||
- 如果出于学习、研究或定制化需求，也可以手动方式安装，具体可见：[从头开始安装](doc/zh-cn/installation/install_from_scratch.md)
|
||||
- **(推荐)** 最简单的安装方式是使用 `Docker`, 只需要一行命令即可完成, 具体可见: [Docker 镜像安装](doc/zh-cn/installation/install_via_docker.md)
|
||||
|
||||
- 如果出于学习、研究或定制化需求, 也可以手动方式安装, 具体可见: [从零开始安装](doc/zh-cn/installation/install_from_scratch.md)
|
||||
|
||||
### **如何更新**
|
||||
|
||||
`CodeFever` 可以进行保留原有数据更新，按照如下文档即可完成更新操作。具体可见: [更新 CodeFever](doc/zh-cn/installation/update.md)
|
||||
`CodeFever` 可以进行保留原有数据更新, 按照如下文档即可完成更新操作。具体可见: [更新 CodeFever](doc/zh-cn/installation/update.md)
|
||||
|
||||
### **使用说明**
|
||||
|
||||
@@ -108,7 +109,7 @@
|
||||
### **问题反馈**
|
||||
|
||||
- 如果你在使用过程中遇到期望外的结果，欢迎提交 `Issue`。参照: [提交问题](doc/zh-cn/contribute/bug_fix_issue.md)
|
||||
- 如果你希望在 `CodeFever Community` 添加一些特性，也欢迎提交 `Issue`。参照: [提交特性请求](doc/zh-cn/contribute/request_feature_issue.md)
|
||||
- 如果你希望在 `CodeFever Community` 添加一些特性, 也欢迎提交 `Issue`。参照: [提交特性请求](doc/zh-cn/contribute/request_feature_issue.md)
|
||||
|
||||
### **贡献代码**
|
||||
|
||||
@@ -123,11 +124,11 @@
|
||||
|
||||
### **关于**
|
||||
|
||||
`CodeFever` 项目起初由 蒲公英开发者服务平台 开发和维护，项目于 2020 年 6 月上线 [https://codefever.pgyer.com/](https://codefever.pgyer.com/) 。 经过将近两年时间打磨和稳定性验证，于 2022 年 2 月开源，接受社区的考验。
|
||||
`CodeFever` 项目起初由 `蒲公英开发者服务平台` 开发和维护, 项目于 2020 年 6 月上线 [https://codefever.pgyer.com/](https://codefever.pgyer.com/) 。 经过将近两年时间打磨和稳定性验证, 于 2022 年 2 月开源, 接受社区的考验。
|
||||
|
||||
`CodeFever` 开源后，开源版本称为 `CodeFever Conmmunity` 版本。同时公有云版本继续服务，继续称为 `CodeFever。`
|
||||
`CodeFever` 开源后, 开源版本称为 `CodeFever Conmmunity` 版本。同时公有云版本继续服务，继续称为 `CodeFever`。
|
||||
|
||||
`CodeFever Community` 由 `蒲公英开发者服务平台` 团队完整自主研发并基于 `MIT` 协议进行完整开源，拥有完全自主的知识产权，因此您可以放心使用而不必考虑是否侵犯他人权利。
|
||||
`CodeFever Community` 由 `蒲公英开发者服务平台` 团队完整自主研发并基于 `MIT` 协议进行完整开源, 拥有完全自主的知识产权, 因此您可以放心使用而不必考虑是否侵犯他人权利。
|
||||
|
||||
`CodeFever Community` 保留了 `CodeFever` 的大部分功能，并且进行了更适合单机部署的优化。`CodeFever Community` 也会随 `CodeFever` 更新的同时接受来自社区的提交。
|
||||
`CodeFever Community` 保留了 `CodeFever` 的大部分功能, 并且进行了更适合单机部署的优化。`CodeFever Community` 也会随 `CodeFever` 更新的同时接受来自社区的提交。
|
||||
|
||||
|
||||
131
README_EN.md
Normal file
131
README_EN.md
Normal file
@@ -0,0 +1,131 @@
|
||||
<div align="center">
|
||||
<br /><br />
|
||||
<a href="https://codefever.cn">
|
||||
<img
|
||||
src="https://assets.pgyer.com/image/view/admin_images/c73a429ef2f134f337ef690dfba4d47f"
|
||||
alt="Logo"
|
||||
height="32"
|
||||
/>
|
||||
</a>
|
||||
<br />
|
||||
<p>
|
||||
<h3>
|
||||
<b>
|
||||
CodeFever Community
|
||||
</b>
|
||||
</h3>
|
||||
</p>
|
||||
<p>
|
||||
<b>
|
||||
A Fully Open Source Code Hosting Service for Git
|
||||
</b>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
[](CODE_OF_CONDUCT.md) [](https://codefever.cn) [](https://github.com/PGYER/codefever/)
|
||||
|
||||
</p>
|
||||
<p>
|
||||
<sub>
|
||||
Built with ❤︎ by
|
||||
<a href="https://codefever.cn">
|
||||
CodeFever
|
||||
</a>
|
||||
</sub>
|
||||
</p>
|
||||
<br />
|
||||
<p>
|
||||
<a href="https://codefever.cn">
|
||||
<img
|
||||
src="https://pgyer-download.oss-cn-shenzhen.aliyuncs.com/codefever-screenshot-1.png"
|
||||
alt="Screenshot"
|
||||
width="100%"
|
||||
/>
|
||||
</a>
|
||||
</p>
|
||||
</div
|
||||
|
||||
[中文说明](README.md)
|
||||
|
||||
<details open>
|
||||
<summary><b>Indexes</b></summary>
|
||||
|
||||
---
|
||||
|
||||
- [Features](#Features)
|
||||
- [Installation](#Installation)
|
||||
- [Upgrade](#Upgrade)
|
||||
- [User Guide](#User%20Guide)
|
||||
- [Feedback](#Feedback)
|
||||
- [Contribute](#Contribute)
|
||||
- [Contribute to Docs](#Contribute%20to%Docs)
|
||||
- [About](#About)
|
||||
|
||||
---
|
||||
|
||||
</details>
|
||||
|
||||
### **Demo**
|
||||
|
||||
[Demo](http://114.132.251.156/) (DO NOT upload the production code, This DEMO is for evaluation purposes only. This demo is running on a 1 vCPU & 1 GB memory VPS)
|
||||
|
||||
### **Features**
|
||||
|
||||
- 🆓 **Free:** Free for everyone to use and don't have to worry about any paying
|
||||
- ❤️ **Open Source:** Fully Open Source without any compiled or encrypted code
|
||||
- 🥬 **Lightweight:** Minimalist design style, excluding heavy redundancy of redundant features
|
||||
- ⚡️ **Efficiency:** Very fast, very low server resource costs, minimum requirement is 1 vCPU & 1G RAM.
|
||||
- ♾️ **Unlimited:** There is no limit to the number of repository
|
||||
- ⌨️ **Code Review:** Highlighting comparison with different versions of code or branches
|
||||
- 🛤️ **Branch:** Full support for Git native branches and Tags to help manage code more clearly
|
||||
- 🙋️ **Merge Request:** Support for team collaboration for smoother code version control
|
||||
- 🙅🏻 **Branch Protection:** Branch protection makes code commits safe and controllable, and code reviews easier and clearer
|
||||
- 👥 **Collaboration:** Team collaboration and the ability to set roles and permissions for each member
|
||||
- 🖥️ **Management:** With super Management protal, you can let the team leader manage all the project and users
|
||||
- 💬 **Language:** Native support for both Chinese and English languages
|
||||
|
||||
### **Installation**
|
||||
|
||||
`CodeFever` provides `Install From Scratch` and `Install Via Docker`, choose the installation method according to your actual needs.
|
||||
|
||||
- **(Recommended)** The easiest way is to use `Docker`, which can be done with a one line of command, see: [Install Via Docker](doc/en-us/installation/install_via_docker.md)
|
||||
- For learning, research or customization needs, you can also install it manually, see: [Install From Scratch](doc/en-us/installation/install_from_scratch.md)
|
||||
|
||||
### **Upgrade**
|
||||
|
||||
`CodeFever` can be updated and keep the original data, follow the documentation to complete the update operation. See: [Update CodeFever](doc/en-us/installation/update.md)
|
||||
|
||||
### **User Guide**
|
||||
|
||||
- [Repository](doc/en-us/repo)
|
||||
- [Repository Group](doc/en-us/repo_group)
|
||||
- [Administrator](doc/en-us/admin)
|
||||
- [Git](doc/en-us/git)
|
||||
- [FAQ](doc/en-us/common)
|
||||
|
||||
### **Feedback**
|
||||
|
||||
- If any issue or inconvenient encountered while using `CodeFever Community`, feel free to submit `Issue`. See: [Bug Fix Issue](doc/en-us/contribute/bug_fix_issue.md)
|
||||
- If you have any idea to improve `CodeFever Community`, feel free to submit an `Issue` as well. See: [Feature Request issue](doc/en-us/contribute/request_feature_issue.md)
|
||||
|
||||
### **Contribute**
|
||||
|
||||
Feel free to submit a `PR`, please make sure to test it properly after fixing the `Bug` or adding a `Feature`.
|
||||
|
||||
- If the content of the `PR` is a bug fix issue, please submit the `Issue` first and reference the `Issue` when submitting the PR. Reference: [Bug Fix PR](doc/en-us/contribute/bug_fix_pr.md)
|
||||
- If the content of the `PR` is a new feature, please describe the feature in as much detail as possible in the `PR`, and if the PR is a commit for a feature request issue, reference the `Issue` when submitting the PR. Reference: [New Feature PR](doc/en-us/contribute/new_feature_pr.md)
|
||||
|
||||
### **Contribute to Docs**
|
||||
|
||||
You are welcome to correct errors in the document or participate in the translation works, please make sure the content of the document is accurate before submitting `PR`, please refer to: [Document PR](doc/en-us/contribute/doc_pr.md)
|
||||
|
||||
### **About**
|
||||
|
||||
The `CodeFever` project was initially developed and maintained by `PGYER` and went live in June 2020 [https://codefever.pgyer.com/](https://codefever.pgyer.com/). After nearly two years of stability verification, the project was open sourced in February 2022 to be tested by the community.
|
||||
|
||||
After `CodeFever` open source, the open source version is called `CodeFever Conmmunity` version. The public cloud version will continue to be called `CodeFever`.
|
||||
|
||||
`CodeFever Community` is developed by the `PGYER` team and is fully open source based on the `MIT` license, and has completely independent property rights, so you can use it without worrying about whether it violates other's rights.
|
||||
|
||||
`CodeFever Community` retains most of the features of `CodeFever` and is optimized for standalone deployment. `CodeFever Community` also accepts community submissions as `CodeFever` is updated.
|
||||
|
||||
@@ -1,74 +1,47 @@
|
||||
# 欢迎使用 CodeFever Community 版本
|
||||
|
||||
### 关于 CodeFever
|
||||
### 安装
|
||||
|
||||
`CodeFever` 项目起初由 蒲公英开发者服务平台 开发和维护，项目于 2020 年 6 月上线 [https://codefever.pgyer.com/](https://codefever.pgyer.com/) 。 经过将近两年时间打磨和稳定性验证，于 2022 年 2 月开源，接受社区的考验。
|
||||
`CodeFever` 提供 `从零开始安装` 和 `Docker 镜像安装` 两种安装方式, 可以根据自己的实际需要选择安装方式。
|
||||
|
||||
`CodeFever` 开源后，开源版本称为 `CodeFever Conmmunity` 版本。同时公有云版本继续服务，继续称为 `CodeFever。`
|
||||
- **(推荐)** 最简单的安装方式是使用 `Docker`, 只需要一行命令即可完成, 具体可见: [Docker 镜像安装](../installation/install_via_docker.md)
|
||||
|
||||
`CodeFever Community` 由 `蒲公英开发者服务平台` 团队完整自主研发并基于 `MIT` 协议进行完整开源，拥有完全自主的知识产权，因此您可以放心使用而不必考虑是否侵犯他人权利。
|
||||
|
||||
`CodeFever Community` 保留了 `CodeFever` 的大部分功能，并且进行了更适合单机部署的优化。`CodeFever Community` 也会随 `CodeFever` 更新的同时接受来自社区的提交。
|
||||
|
||||
### 如何安装
|
||||
|
||||
`CodeFever` 提供 `从头开始安装` 和 `Docker 镜像安装` 两种安装方式, 可以根据自己的实际需要选择安装方式。
|
||||
|
||||
满足以下要求的用户和选择 `从头开始安装` 的方式进行安装。
|
||||
|
||||
- 学习和技术交流
|
||||
- 需要做定制化修改
|
||||
- `Docker 镜像安装` 不能满足处理 `Bug` 和提交 `PR` 的需求
|
||||
- Docker 镜像不能在当前 `操作系统` 或 `硬件架构` 上使用
|
||||
|
||||
参照: [从头开始安装](../installation/install_from_scratch.md)
|
||||
|
||||
如果不满足上述要求，你可以选择使用 `Docker 镜像安装` 方式安装 `CodeFever Community`。
|
||||
|
||||
参照: [Docker 镜像安装](../installation/install_via_docker.md)
|
||||
- 如果出于学习、研究或定制化需求, 也可以手动方式安装, 具体可见: [从零开始安装](../installation/install_from_scratch.md)
|
||||
|
||||
### 更新
|
||||
|
||||
`CodeFever` 可以进行保留原有数据更新，按照如下文档即可完成更新操作。具体可见：[更新 CodeFever](../installation/update.md)
|
||||
`CodeFever` 可以进行保留原有数据更新, 按照如下文档即可完成更新操作。具体可见：[更新 CodeFever](../installation/update.md)
|
||||
|
||||
### 使用
|
||||
|
||||
[仓库](../reposiotry)
|
||||
|
||||
[仓库组](../reposiotry_group)
|
||||
|
||||
[管理员设置](../admin)
|
||||
|
||||
[Git](../git)
|
||||
|
||||
[常见问题](../common)
|
||||
- [仓库](../reposiotry)
|
||||
- [仓库组](../reposiotry_group)
|
||||
- [管理员设置](../admin)
|
||||
- [Git](../git)
|
||||
- [常见问题](../common)
|
||||
|
||||
### 问题反馈
|
||||
|
||||
如果你在使用过程中遇到期望外的结果，欢迎提交 `Issue`。
|
||||
|
||||
参照: [提交问题](../contribute/bug_fix_issue.md)
|
||||
|
||||
如果你希望在 `CodeFever Community` 添加一些特性，也欢迎提交 `Issue`。
|
||||
|
||||
参照: [提交特性请求](../contribute/request_feature_issue.md)
|
||||
- 如果你在使用过程中遇到期望外的结果，欢迎提交 `Issue`。参照: [提交问题](../contribute/bug_fix_issue.md)
|
||||
- 如果你希望在 `CodeFever Community` 添加一些特性, 也欢迎提交 `Issue`。参照: [提交特性请求](../contribute/request_feature_issue.md)
|
||||
|
||||
### 贡献代码
|
||||
|
||||
欢迎提交 `PR`, 请确定修复 `Bug` 后或者新增 `Feature` 后进行适当的测试。
|
||||
|
||||
如果 `PR` 内容是问题，请先提交 `Issue` 并在提交 PR 时引用该 `Issue`。
|
||||
|
||||
参照: [提交问题修复](../contribute/bug_fix_pr.md)
|
||||
|
||||
如果 `PR` 内容是新特性，请在 `PR` 中请尽量详细描述此特性的内容，如果此 PR 是针对某个特性请求的提交，在提交 PR 时引用该 `Issue`。
|
||||
|
||||
参照: [提交新特性](../contribute/new_feature_pr.md)
|
||||
- 如果 `PR` 内容是问题，请先提交 `Issue` 并在提交 PR 时引用该 `Issue`。参照: [提交问题修复](../contribute/bug_fix_pr.md)
|
||||
- 如果 `PR` 内容是新特性，请在 `PR` 中请尽量详细描述此特性的内容, 如果此 PR 是针对某个特性请求的提交, 在提交 PR 时引用该 `Issue`。参照: [提交新特性](../contribute/new_feature_pr.md)
|
||||
|
||||
### 贡献文档
|
||||
|
||||
欢迎指正文档中的错误或参加翻译工作
|
||||
欢迎指正文档中的错误或参加翻译工作，提交 `PR` 前请确定文档内容表述是否准确，具体参照: [提交文档](../contribute/doc_pr.md)
|
||||
|
||||
提交 `PR` 前请确定文档内容表述是否准确
|
||||
### 关于 CodeFever
|
||||
|
||||
参照: [提交文档](../contribute/doc_pr.md)
|
||||
`CodeFever` 项目起初由 `蒲公英开发者服务平台` 开发和维护, 项目于 2020 年 6 月上线 [https://codefever.pgyer.com/](https://codefever.pgyer.com/) 。 经过将近两年时间打磨和稳定性验证, 于 2022 年 2 月开源, 接受社区的考验。
|
||||
|
||||
`CodeFever` 开源后, 开源版本称为 `CodeFever Conmmunity` 版本。同时公有云版本继续服务，继续称为 `CodeFever`。
|
||||
|
||||
`CodeFever Community` 由 `蒲公英开发者服务平台` 团队完整自主研发并基于 `MIT` 协议进行完整开源, 拥有完全自主的知识产权, 因此您可以放心使用而不必考虑是否侵犯他人权利。
|
||||
|
||||
`CodeFever Community` 保留了 `CodeFever` 的大部分功能, 并且进行了更适合单机部署的优化。`CodeFever Community` 也会随 `CodeFever` 更新的同时接受来自社区的提交。
|
||||
|
||||
@@ -28,7 +28,7 @@ echo 'Test Group Data Removed!'
|
||||
|
||||
rm -rf ../git-storage/7b56eed88bda864c6e5ae1540549f8ab
|
||||
|
||||
echo 'Test Repository Removed'
|
||||
echo 'Test Repository Removed!'
|
||||
|
||||
echo 'Done!'
|
||||
echo 'All Test Data Removed !'
|
||||
echo 'All Test Data Removed!'
|
||||
|
||||
Reference in New Issue
Block a user