mirror of
https://github.com/PGYER/codefever.git
synced 2026-05-07 05:57:30 +08:00
135 lines
5.6 KiB
Markdown
135 lines
5.6 KiB
Markdown
<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>
|
||
完全开源的 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
|
||
|
||
英文版本文档正在完善中, 欢迎 [提交文档](doc/zh-cn/contribute/doc_pr.md)
|
||
|
||
[English](README_EN.md)
|
||
|
||
<details open>
|
||
<summary><b>目录</b></summary>
|
||
|
||
---
|
||
|
||
- [功能特性](#功能特性)
|
||
- [如何安装](#如何安装)
|
||
- [如何更新](#如何更新)
|
||
- [使用说明](#使用说明)
|
||
- [问题反馈](#问题反馈)
|
||
- [贡献代码](#贡献代码)
|
||
- [贡献文档](#贡献文档)
|
||
- [关于](#关于)
|
||
|
||
---
|
||
|
||
</details>
|
||
|
||
### **Demo**
|
||
|
||
[请点击这里查看 Demo](http://43.132.120.17/)（仅测试使用，请勿上传正式代码，本 Demo 运行在 1 核 1 GB 内存的云服务器上，大家可以体验下速度）
|
||
|
||
### **功能特性**
|
||
|
||
- 🆓 **永久免费:** 永久免费提供给大家使用，您无需担心付费
|
||
- ❤️ **完整开源:** 毫无保留的完整开源，无任何编译或加密代码
|
||
- 🥬 **轻量安装:** 极简设计风格，排除重度冗余的多余功能
|
||
- ⚡️ **性能高效:** 速度极快，对服务器资源要求极低，1核CPU/1G内存即可运行
|
||
- ♾️ **无限仓库:** 没有任何仓库数量、使用数量的限制
|
||
- ⌨️ **代码对比:** 支持提交代码的不同版本支持高亮显示对比
|
||
- 🛤️ **分支管理:** 完整支持 Git 原生分支和 Tag，帮助更清晰的管理代码
|
||
- 🙋♂️ **合并请求（Merge Request）:** 支持多人协作，让代码版本控制更顺畅
|
||
- 🙅🏻♀️ **分支保护:** 分支保护功能让代码提交安全可控，代码 Review 更容易清晰
|
||
- 👥 **多人协作:** 支持多人团队协作，并可以设置每个成员的角色和权限
|
||
- 🔌 **Webhook:** 支持Webhook功能，可轻松和其他系统进行集成
|
||
- 🖥️ **管理后台:** 支持超级管理员后台，可以让团队leader管理所有项目和用户信息
|
||
- 💬 **中英双语:** 原生支持中文和英文两种语言
|
||
|
||
### **如何安装**
|
||
|
||
`CodeFever` 提供 `从零开始安装` 和 `Docker 镜像安装` 两种安装方式，可以根据自己的实际需要选择安装方式。
|
||
|
||
- **(推荐)** 最简单的安装方式是使用 `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)
|
||
|
||
### **使用说明**
|
||
|
||
- [仓库](doc/zh-cn/repo)
|
||
- [仓库组](doc/zh-cn/repo_group)
|
||
- [管理员设置](doc/zh-cn/admin)
|
||
- [Git](doc/zh-cn/git)
|
||
- [常见问题](doc/zh-cn/common)
|
||
|
||
### **问题反馈**
|
||
|
||
- 如果你在使用过程中遇到期望外的结果，欢迎提交 `Issue`。参照: [提交问题](doc/zh-cn/contribute/bug_fix_issue.md)
|
||
- 如果你希望在 `CodeFever Community` 添加一些特性, 也欢迎提交 `Issue`。参照: [提交特性请求](doc/zh-cn/contribute/request_feature_issue.md)
|
||
|
||
### **贡献代码**
|
||
|
||
欢迎提交 `PR`, 请确定修复 `Bug` 后或者新增 `Feature` 后进行适当的测试。
|
||
|
||
- 如果 `PR` 内容是问题，请先提交 `Issue` 并在提交 PR 时引用该 `Issue`。参照: [提交问题修复](doc/zh-cn/contribute/bug_fix_pr.md)
|
||
- 如果 `PR` 内容是新特性，请在 `PR` 中请尽量详细描述此特性的内容，如果此 PR 是针对某个特性请求的提交，在提交 PR 时引用该 `Issue`。参照: [提交新特性](doc/zh-cn/contribute/new_feature_pr.md)
|
||
|
||
### 贡献文档
|
||
|
||
欢迎指正文档中的错误或参加翻译工作，提交 `PR` 前请确定文档内容表述是否准确，具体参照: [提交文档](doc/zh-cn/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` 更新的同时接受来自社区的提交。
|
||
|