2021-01-01 20:04:35 +01:00
< p align = "center" >
< a href = "https://gitea.io/" >
2021-05-04 18:16:23 +02:00
< img alt = "Gitea" src = "https://raw.githubusercontent.com/go-gitea/gitea/main/public/img/gitea.svg" width = "220" / >
2021-01-01 20:04:35 +01:00
< / a >
< / p >
< h1 align = "center" > Gitea - Git with a cup of tea< / h1 >
2016-12-19 14:30:52 +01:00
2021-01-01 20:04:35 +01:00
< p align = "center" >
< a href = "https://drone.gitea.io/go-gitea/gitea" title = "Build Status" >
2021-05-04 18:16:23 +02:00
< img src = "https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg?ref=refs/heads/main" >
2021-01-01 20:04:35 +01:00
< / a >
< a href = "https://discord.gg/Gitea" title = "Join the Discord chat at https://discord.gg/Gitea" >
< img src = "https://img.shields.io/discord/322538954119184384.svg" >
< / a >
< a href = "https://codecov.io/gh/go-gitea/gitea" title = "Codecov" >
2021-05-04 18:16:23 +02:00
< img src = "https://codecov.io/gh/go-gitea/gitea/branch/main/graph/badge.svg" >
2021-01-01 20:04:35 +01:00
< / a >
2021-08-31 01:06:30 +02:00
< a href = "https://goreportcard.com/report/code.gitea.io/gitea" title = "Go Report Card" >
2021-01-01 20:04:35 +01:00
< img src = "https://goreportcard.com/badge/code.gitea.io/gitea" >
< / a >
< a href = "https://godoc.org/code.gitea.io/gitea" title = "GoDoc" >
< img src = "https://godoc.org/code.gitea.io/gitea?status.svg" >
< / a >
< a href = "https://github.com/go-gitea/gitea/releases/latest" title = "GitHub release" >
< img src = "https://img.shields.io/github/release/go-gitea/gitea.svg" >
< / a >
< a href = "https://www.codetriage.com/go-gitea/gitea" title = "Help Contribute to Open Source" >
< img src = "https://www.codetriage.com/go-gitea/gitea/badges/users.svg" >
< / a >
< a href = "https://opencollective.com/gitea" title = "Become a backer/sponsor of gitea" >
< img src = "https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen" >
< / a >
< a href = "https://opensource.org/licenses/MIT" title = "License: MIT" >
< img src = "https://img.shields.io/badge/License-MIT-blue.svg" >
< / a >
< a href = "https://crowdin.com/project/gitea" title = "Crowdin" >
< img src = "https://badges.crowdin.net/gitea/localized.svg" >
< / a >
2022-01-04 17:46:32 +01:00
< a href = "https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea&branch=main" title = "TODOs" >
< img src = "https://badgen.net/https/api.tickgit.com/badgen/github.com/go-gitea/gitea/main" >
2021-01-01 20:04:35 +01:00
< / a >
2021-01-13 16:55:52 +01:00
< a href = "https://www.bountysource.com/teams/gitea" title = "Bountysource" >
2021-01-13 16:53:17 +01:00
< img src = "https://img.shields.io/bountysource/team/gitea/activity" >
< / a >
2021-01-01 20:04:35 +01:00
< / p >
2016-11-03 15:50:44 +01:00
2021-01-01 20:04:35 +01:00
< p align = "center" >
< a href = "README_ZH.md" > View the chinese version of this document< / a >
< / p >
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
2021-12-24 04:56:57 +01:00
or if SQLite support is required:
2020-01-29 03:30:02 +01:00
TAGS="bindata sqlite sqlite_unlock_notify" make build
2020-02-22 10:15:11 +01:00
The `build` target is split into two sub-targets:
2022-06-10 05:34:41 +02:00
- `make backend` which requires [Go Stable ](https://go.dev/dl/ ), required version is defined in [go.mod ](/go.mod ).
2021-11-18 17:45:00 +01:00
- `make frontend` which requires [Node.js LTS ](https://nodejs.org/en/download/ ) or greater and Internet connectivity to download npm dependencies.
2020-02-22 10:15:11 +01:00
2021-04-09 07:08:14 +02:00
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 and Internet connectivity.
2020-02-22 10:15:11 +01:00
2021-04-09 07:08:14 +02:00
Parallelism (`make -j < num > `) is not supported.
2020-07-30 23:21:59 +02:00
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!
2021-05-12 17:02:55 +02:00
## Translating
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.
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 fo fill it as questions pop up.
https://docs.gitea.io/en-us/translation-guidelines/
[](https://crowdin.com/project/gitea)
2018-01-01 14:38:49 +01:00
## Further information
2020-12-06 14:56:46 +01:00
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/Gitea ) or create a post in the [discourse forum ](https://discourse.gitea.io/ ).
We maintain a list of Gitea-related projects at [gitea/awesome-gitea ](https://gitea.com/gitea/awesome-gitea ).
2020-12-28 18:08:01 +01:00
The hugo-based documentation theme is hosted at [gitea/theme ](https://gitea.com/gitea/theme ).
2020-12-06 14:56:46 +01:00
The official Gitea CLI is developed at [gitea/tea ](https://gitea.com/gitea/tea ).
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 [/ɡ ɪ ’ ](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.
2021-05-04 18:16:23 +02:00
See the [LICENSE ](https://github.com/go-gitea/gitea/blob/main/LICENSE ) file
2017-08-30 03:27:23 +02:00
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
||||
2018-06-09 02:13:41 +02:00
|:---:|:---:|:---:|
2019-11-05 01:12:58 +01:00
||||
|||
|||
