You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 9.0KB

10 years ago
10 years ago
8 years ago
8 years ago
10 years ago
10 years ago
10 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <p align="center">
  2. <a href="https://gitea.io/">
  3. <img alt="Gitea" src="https://raw.githubusercontent.com/go-gitea/gitea/main/public/assets/img/gitea.svg" width="220"/>
  4. </a>
  5. </p>
  6. <h1 align="center">Gitea - Git with a cup of tea</h1>
  7. <p align="center">
  8. <a href="https://github.com/go-gitea/gitea/actions/workflows/release-nightly.yml?query=branch%3Amain" title="Release Nightly">
  9. <img src="https://github.com/go-gitea/gitea/actions/workflows/release-nightly.yml/badge.svg?branch=main">
  10. </a>
  11. <a href="https://discord.gg/Gitea" title="Join the Discord chat at https://discord.gg/Gitea">
  12. <img src="https://img.shields.io/discord/322538954119184384.svg?logo=discord&logoColor=white&label=Discord&color=5865F2">
  13. </a>
  14. <a href="https://app.codecov.io/gh/go-gitea/gitea" title="Codecov">
  15. <img src="https://codecov.io/gh/go-gitea/gitea/branch/main/graph/badge.svg">
  16. </a>
  17. <a href="https://goreportcard.com/report/code.gitea.io/gitea" title="Go Report Card">
  18. <img src="https://goreportcard.com/badge/code.gitea.io/gitea">
  19. </a>
  20. <a href="https://pkg.go.dev/code.gitea.io/gitea" title="GoDoc">
  21. <img src="https://pkg.go.dev/badge/code.gitea.io/gitea?status.svg">
  22. </a>
  23. <a href="https://github.com/go-gitea/gitea/releases/latest" title="GitHub release">
  24. <img src="https://img.shields.io/github/release/go-gitea/gitea.svg">
  25. </a>
  26. <a href="https://www.codetriage.com/go-gitea/gitea" title="Help Contribute to Open Source">
  27. <img src="https://www.codetriage.com/go-gitea/gitea/badges/users.svg">
  28. </a>
  29. <a href="https://opencollective.com/gitea" title="Become a backer/sponsor of gitea">
  30. <img src="https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen">
  31. </a>
  32. <a href="https://opensource.org/licenses/MIT" title="License: MIT">
  33. <img src="https://img.shields.io/badge/License-MIT-blue.svg">
  34. </a>
  35. <a href="https://gitpod.io/#https://github.com/go-gitea/gitea">
  36. <img
  37. src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod"
  38. alt="Contribute with Gitpod"
  39. />
  40. </a>
  41. <a href="https://crowdin.com/project/gitea" title="Crowdin">
  42. <img src="https://badges.crowdin.net/gitea/localized.svg">
  43. </a>
  44. <a href="https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea&branch=main" title="TODOs">
  45. <img src="https://badgen.net/https/api.tickgit.com/badgen/github.com/go-gitea/gitea/main">
  46. </a>
  47. </p>
  48. <p align="center">
  49. <a href="README_ZH.md">View this document in Chinese</a>
  50. </p>
  51. ## Purpose
  52. The goal of this project is to make the easiest, fastest, and most
  53. painless way of setting up a self-hosted Git service.
  54. As Gitea is written in Go, it works across **all** the platforms and
  55. architectures that are supported by Go, including Linux, macOS, and
  56. Windows on x86, amd64, ARM and PowerPC architectures.
  57. This project has been
  58. [forked](https://blog.gitea.com/welcome-to-gitea/) from
  59. [Gogs](https://gogs.io) since November of 2016, but a lot has changed.
  60. For online demonstrations, you can visit [try.gitea.io](https://try.gitea.io).
  61. For accessing free Gitea service (with a limited number of repositories), you can visit [gitea.com](https://gitea.com/user/login).
  62. To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at [cloud.gitea.com](https://cloud.gitea.com).
  63. ## Building
  64. From the root of the source tree, run:
  65. TAGS="bindata" make build
  66. or if SQLite support is required:
  67. TAGS="bindata sqlite sqlite_unlock_notify" make build
  68. The `build` target is split into two sub-targets:
  69. - `make backend` which requires [Go Stable](https://go.dev/dl/), the required version is defined in [go.mod](/go.mod).
  70. - `make frontend` which requires [Node.js LTS](https://nodejs.org/en/download/) or greater.
  71. Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the `frontend` target will not be triggered, making it possible to build without Node.js.
  72. More info: https://docs.gitea.com/installation/install-from-source
  73. ## Using
  74. ./gitea web
  75. > [!NOTE]
  76. > If you're interested in using our APIs, we have experimental support with [documentation](https://try.gitea.io/api/swagger).
  77. ## Contributing
  78. Expected workflow is: Fork -> Patch -> Push -> Pull Request
  79. > [!NOTE]
  80. >
  81. > 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
  82. > 2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
  83. ## Translating
  84. Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.
  85. You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.
  86. https://docs.gitea.com/contributing/localization
  87. [![Crowdin](https://badges.crowdin.net/gitea/localized.svg)](https://crowdin.com/project/gitea)
  88. ## Further information
  89. For more information and instructions about how to install Gitea, please look at our [documentation](https://docs.gitea.com/).
  90. If you have questions that are not covered by the documentation, you can get in contact with us on our [Discord server](https://discord.gg/Gitea) or create a post in the [discourse forum](https://discourse.gitea.io/).
  91. We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea).
  92. The official Gitea CLI is developed at [gitea/tea](https://gitea.com/gitea/tea).
  93. ## Authors
  94. - [Maintainers](https://github.com/orgs/go-gitea/people)
  95. - [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
  96. - [Translators](options/locale/TRANSLATORS)
  97. ## Backers
  98. Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
  99. <a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
  100. ## Sponsors
  101. Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/gitea#sponsor)]
  102. <a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
  103. <a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
  104. <a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
  105. <a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
  106. <a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
  107. <a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
  108. <a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
  109. <a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
  110. <a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
  111. <a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
  112. ## FAQ
  113. **How do you pronounce Gitea?**
  114. Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
  115. **Why is this not hosted on a Gitea instance?**
  116. We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
  117. ## License
  118. This project is licensed under the MIT License.
  119. See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file
  120. for the full license text.
  121. ## Screenshots
  122. Looking for an overview of the interface? Check it out!
  123. |![Dashboard](https://dl.gitea.com/screenshots/home_timeline.png)|![User Profile](https://dl.gitea.com/screenshots/user_profile.png)|![Global Issues](https://dl.gitea.com/screenshots/global_issues.png)|
  124. |:---:|:---:|:---:|
  125. |![Branches](https://dl.gitea.com/screenshots/branches.png)|![Web Editor](https://dl.gitea.com/screenshots/web_editor.png)|![Activity](https://dl.gitea.com/screenshots/activity.png)|
  126. |![New Migration](https://dl.gitea.com/screenshots/migration.png)|![Migrating](https://dl.gitea.com/screenshots/migration.gif)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)|
  127. |![Pull Request Dark](https://dl.gitea.com/screenshots/pull_requests_dark.png)|![Diff Review Dark](https://dl.gitea.com/screenshots/review_dark.png)|![Diff Dark](https://dl.gitea.com/screenshots/diff_dark.png)|