From e1460b7f2f81632c41b45b2b3faa04644b808627 Mon Sep 17 00:00:00 2001 From: rexshi Date: Wed, 9 Feb 2022 17:33:48 +0800 Subject: [PATCH] Create README_EN.md --- README_EN.md | 131 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 README_EN.md diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..9d78fc4 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,131 @@ +
+

+ + Logo + +
+

+

+ + CodeFever Community + +

+

+

+ + Fully Open Source Code Hosting Service for Git + +

+

+ +[![contributions welcome](https://img.shields.io/badge/Contributions-welcome-brightgreen?logo=github)](CODE_OF_CONDUCT.md) [![Website](https://img.shields.io/badge/Website-available-brightgreen?logo=e)](https://codefever.cn) [![Docker](https://img.shields.io/badge/Docker-passing-brightgreen?logo=docker)](https://github.com/PGYER/codefever/) + +

+

+ + Built with ❤︎ by + + CodeFever + + +

+
+

+ + Screenshot + +

+
+ Indexes + +--- + +- [Features](#Features) +- [Installation](#Installation) +- [Upgrade](#Upgrade) +- [Instruction](#Instruction) +- [Feedback](#Feedback) +- [Contribute](#Contribute) +- [Document](#Document) +- [About](#About) + +--- + + + +### **Demo** + +[Demo](http://114.132.251.156/) (Please do not upload the production code, it is for testing only. This demo is running on a 1 core 1 GB memory cloud server.) + +### **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) + +### **Instruction** + +- [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 you encounter unexpected results in the process, feel free to submit `Issue`. See also: [Bug Fix Issue](doc/en-us/contribute/bug_fix_issue.md) +- If you want to add some features to the `CodeFever Community`, feel free to submit an `Issue` as well. Reference: [Request feature 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 an 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, reference the `Issue` when submitting the PR. Reference: [New Feature PR](doc/en-us/contribute/new_feature_pr.md) + +### Document + +You are welcome to correct errors in the document or participate in the translation work, 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`, 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. +