2019-11-05 01:12:58 +01:00
[简体中文 ](README_ZH.md )
2016-12-19 14:30:52 +01:00
2019-10-19 23:14:38 +02:00
< h1 > < img src = "https://raw.githubusercontent.com/go-gitea/gitea/master/public/img/gitea-192.png" alt = "logo" width = "30" height = "30" > Gitea - Git with a cup of tea< / h1 >
2016-11-03 15:50:44 +01:00
2017-01-15 14:31:34 +01:00
[![Build Status ](https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg )](https://drone.gitea.io/go-gitea/gitea)
2017-08-21 17:35:08 +02:00
[![Join the Discord chat at https://discord.gg/NsatcWJ ](https://img.shields.io/discord/322538954119184384.svg )](https://discord.gg/NsatcWJ)
2017-01-15 14:31:34 +01: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 14:57:55 +02:00
[![codecov ](https://codecov.io/gh/go-gitea/gitea/branch/master/graph/badge.svg )](https://codecov.io/gh/go-gitea/gitea)
2016-11-24 21:43:05 +01: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 22:38:57 +02:00
[![GitHub release ](https://img.shields.io/github/release/go-gitea/gitea.svg )](https://github.com/go-gitea/gitea/releases/latest)
2018-01-09 00:01:08 +01: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 21:51:54 +02: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-19 04:01:38 +02:00
[![License: MIT ](https://img.shields.io/badge/License-MIT-blue.svg )](https://opensource.org/licenses/MIT)
2019-10-10 04:16:58 +02:00
[![Crowdin ](https://badges.crowdin.net/gitea/localized.svg )](https://crowdin.com/project/gitea)
2014-03-13 07:55:14 +01:00
2014-02-12 18:49:46 +01:00
## Purpose
2017-08-30 03:27:23 +02: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 12:23:55 +01:00
[Gogs ](https://gogs.io ) since 2016.11 but changed a lot.
2015-10-29 08:21:59 +01:00
2018-01-01 14:38:49 +01:00
## Building
2015-09-12 15:21:09 +02:00
2018-01-01 14:38:49 +01:00
From the root of the source tree, run:
2014-02-12 18:49:46 +01:00
2019-12-08 17:56:59 +01:00
TAGS="bindata" make build
2014-02-12 18:49:46 +01:00
2020-02-22 12:51:58 +01:00
The `build` target is split into two sub-targets:
- `make backend` which requires [Go 1.11 ](https://golang.org/dl/ ) or greater.
- `make frontend` which requires [Node.js 10.0.0 ](https://nodejs.org/en/download/ ) or greater.
If pre-built frontend files are present it is possible to only build the backend:
TAGS="bindata" make backend
2018-01-01 14:38:49 +01: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-11-01 01:18:28 +01:00
support with [documentation ](https://try.gitea.io/api/swagger ).
2014-02-12 18:49:46 +01:00
2016-11-28 14:34:06 +01:00
## Contributing
2018-01-01 14:38:49 +01: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 14:34:06 +01:00
## Authors
* [Maintainers ](https://github.com/orgs/go-gitea/people )
* [Contributors ](https://github.com/go-gitea/gitea/graphs/contributors )
2016-12-23 15:05:24 +01:00
* [Translators ](options/locale/TRANSLATORS )
2014-03-27 17:34:12 +01:00
2018-05-11 07:53:23 +02: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-05 02:15:32 +02: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 22:41:31 +02: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 17:34:12 +01:00
## License
2017-08-30 03:27:23 +02: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-09 02:13:41 +02:00
## Screenshots
Looking for an overview of the interface? Check it out!
2019-11-05 01:12:58 +01:00
|![Dashboard](https://dl.gitea.io/screenshots/home_timeline.png)|![User Profile](https://dl.gitea.io/screenshots/user_profile.png)|![Global Issues](https://dl.gitea.io/screenshots/global_issues.png)|
2018-06-09 02:13:41 +02:00
|:---:|:---:|:---:|
2019-11-05 01:12:58 +01:00
|![Branches](https://dl.gitea.io/screenshots/branches.png)|![Web Editor](https://dl.gitea.io/screenshots/web_editor.png)|![Activity](https://dl.gitea.io/screenshots/activity.png)|
|![New Migration](https://dl.gitea.io/screenshots/migration.png)|![Migrating](https://dl.gitea.io/screenshots/migration.gif)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)
![Pull Request Dark ](https://dl.gitea.io/screenshots/pull_requests_dark.png )|![Diff Review Dark](https://dl.gitea.io/screenshots/review_dark.png)|![Diff Dark](https://dl.gitea.io/screenshots/diff_dark.png)|