2016-12-19 08:30:52 -05:00
[简体中文 ](https://github.com/go-gitea/gitea/blob/master/README_ZH.md )
2016-11-03 10:50:44 -04:00
# Gitea - Git with a cup of tea
2017-01-15 08:31:34 -05:00
[![Build Status ](https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg )](https://drone.gitea.io/go-gitea/gitea)
2017-08-21 11:35:08 -04:00
[![Join the Discord chat at https://discord.gg/NsatcWJ ](https://img.shields.io/discord/322538954119184384.svg )](https://discord.gg/NsatcWJ)
2017-01-15 08:31:34 -05:00
[![ ](https://images.microbadger.com/badges/image/gitea/gitea.svg )](https://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com")
2017-09-13 08:57:55 -04:00
[![codecov ](https://codecov.io/gh/go-gitea/gitea/branch/master/graph/badge.svg )](https://codecov.io/gh/go-gitea/gitea)
2016-11-24 15:43:05 -05:00
[![Go Report Card ](https://goreportcard.com/badge/code.gitea.io/gitea )](https://goreportcard.com/report/code.gitea.io/gitea)
[![GoDoc ](https://godoc.org/code.gitea.io/gitea?status.svg )](https://godoc.org/code.gitea.io/gitea)
2018-05-10 16:38:57 -04:00
[![GitHub release ](https://img.shields.io/github/release/go-gitea/gitea.svg )](https://github.com/go-gitea/gitea/releases/latest)
2018-01-08 18:01:08 -05:00
[![Help Contribute to Open Source ](https://www.codetriage.com/go-gitea/gitea/badges/users.svg )](https://www.codetriage.com/go-gitea/gitea)
2019-10-07 15:51:54 -04:00
[![Become a backer/sponsor of gitea ](https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen )](https://opencollective.com/gitea)
2019-09-18 22:01:38 -04:00
[![License: MIT ](https://img.shields.io/badge/License-MIT-blue.svg )](https://opensource.org/licenses/MIT)
2014-03-13 02:55:14 -04:00
2014-02-12 12:49:46 -05:00
## Purpose
2017-08-29 21:27:23 -04:00
The goal of this project is to make the easiest, fastest, and most
painless way of setting up a self-hosted Git service.
Using Go, this can be done with an independent binary distribution across
**all platforms** which Go supports, including Linux, macOS, and Windows
on x86, amd64, ARM and PowerPC architectures.
Want to try it before doing anything else?
Do it [with the online demo ](https://try.gitea.io/ )!
This project has been
[forked ](https://blog.gitea.io/2016/12/welcome-to-gitea/ ) from
2017-11-14 06:23:55 -05:00
[Gogs ](https://gogs.io ) since 2016.11 but changed a lot.
2015-10-29 03:21:59 -04:00
2018-01-01 08:38:49 -05:00
## Building
2015-09-12 09:21:09 -04:00
2018-01-01 08:38:49 -05:00
From the root of the source tree, run:
2014-02-12 12:49:46 -05:00
2018-10-03 02:33:46 -04:00
TAGS="bindata" make generate all
2014-02-12 12:49:46 -05:00
2018-01-01 08:38:49 -05:00
More info: https://docs.gitea.io/en-us/install-from-source/
## Using
./gitea web
NOTE: If you're interested in using our APIs, we have experimental
2018-10-31 20:18:28 -04:00
support with [documentation ](https://try.gitea.io/api/swagger ).
2014-02-12 12:49:46 -05:00
2016-11-28 08:34:06 -05:00
## Contributing
2018-01-01 08:38:49 -05:00
Expected workflow is: Fork -> Patch -> Push -> Pull Request
NOTES:
1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
2. If you have found a vulnerability in the project, please write privately to **security@gitea.io** . Thanks!
## Further information
For more information and instructions about how to install Gitea, please look
at our [documentation ](https://docs.gitea.io/en-us/ ). 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/NsatcWJ ),
or [forum ](https://discourse.gitea.io/ )!
2016-11-28 08:34:06 -05:00
## Authors
* [Maintainers ](https://github.com/orgs/go-gitea/people )
* [Contributors ](https://github.com/go-gitea/gitea/graphs/contributors )
2016-12-23 09:05:24 -05:00
* [Translators ](options/locale/TRANSLATORS )
2014-03-27 12:34:12 -04:00
2018-05-11 01:53:23 -04:00
## Backers
Thank you to all our backers! 🙏 [[Become a backer ](https://opencollective.com/gitea#backer )]
< a href = "https://opencollective.com/gitea#backers" target = "_blank" > < img src = "https://opencollective.com/gitea/backers.svg?width=890" > < / a >
## Sponsors
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 )]
< a href = "https://opencollective.com/gitea/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/gitea/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/gitea/sponsor/9/avatar.svg" > < / a >
2018-06-04 20:15:32 -04:00
## FAQ
**How do you pronounce Gitea?**
Gitea is pronounced [/ɡ ɪ ’ ti:/ ](https://youtu.be/EM71-2uDAoY ) as in "gi-tea" with a hard g.
2018-07-08 16:41:31 -04:00
**Why is this not hosted on a Gitea instance?**
We're [working on it ](https://github.com/go-gitea/gitea/issues/1029 ).
2014-03-27 12:34:12 -04:00
## License
2017-08-29 21:27:23 -04:00
This project is licensed under the MIT License.
See the [LICENSE ](https://github.com/go-gitea/gitea/blob/master/LICENSE ) file
for the full license text.
2018-06-08 20:13:41 -04:00
## Screenshots
Looking for an overview of the interface? Check it out!
| | | |
|:---:|:---:|:---:|
|![Dashboard](https://image.ibb.co/dms6DG/1.png)|![Repository](https://image.ibb.co/m6MSLw/2.png)|![Commits History](https://image.ibb.co/cjrSLw/3.png)|
|![Branches](https://image.ibb.co/e6vbDG/4.png)|![Issues](https://image.ibb.co/bJTJSb/5.png)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)|
|![Releases](https://image.ibb.co/cUzgfw/7.png)|![Activity](https://image.ibb.co/eZgGDG/8.png)|![Wiki](https://image.ibb.co/dYV9YG/9.png)|
|![Diff](https://image.ibb.co/ewA9YG/10.png)|![Organization](https://image.ibb.co/ceOwDG/11.png)|![Profile](https://image.ibb.co/c44Q7b/12.png)|