mirror of
https://github.com/PGYER/codefever.git
synced 2026-05-07 05:57:30 +08:00
133 lines
5.8 KiB
Markdown
133 lines
5.8 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>
|
|
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://43.132.120.17/) (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
|
|
- 🔌 **Integration:** Eeasily integrated with other systems you are using via webhook, for example, jira, jenkins, etc.
|
|
- 🖥️ **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.
|
|
|