2021-01-01 13:04:35 -06:00
< p align = "center" >
< a href = "https://gitea.io/" >
2021-05-04 11:16:23 -05:00
< img alt = "Gitea" src = "https://raw.githubusercontent.com/go-gitea/gitea/main/public/img/gitea.svg" width = "220" / >
2021-01-01 13:04:35 -06:00
< / a >
< / p >
< h1 align = "center" > Gitea - Git with a cup of tea< / h1 >
2016-12-19 07:30:52 -06:00
2021-01-01 13:04:35 -06:00
< p align = "center" >
< a href = "https://drone.gitea.io/go-gitea/gitea" title = "Build Status" >
2021-05-04 11:16:23 -05:00
< img src = "https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg?ref=refs/heads/main" >
2021-01-01 13:04:35 -06: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 11:16:23 -05:00
< img src = "https://codecov.io/gh/go-gitea/gitea/branch/main/graph/badge.svg" >
2021-01-01 13:04:35 -06:00
< / a >
2021-08-30 18:06:30 -05:00
< a href = "https://goreportcard.com/report/code.gitea.io/gitea" title = "Go Report Card" >
2021-01-01 13:04:35 -06: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 >
2022-10-12 11:17:04 -05:00
< a href = "https://gitpod.io/#https://github.com/go-gitea/gitea" >
< img
src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod"
alt="Contribute with Gitpod"
/>
< / a >
2021-01-01 13:04:35 -06:00
< a href = "https://crowdin.com/project/gitea" title = "Crowdin" >
< img src = "https://badges.crowdin.net/gitea/localized.svg" >
< / a >
2022-01-04 10:46:32 -06: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 13:04:35 -06:00
< / a >
2021-01-13 09:55:52 -06:00
< a href = "https://www.bountysource.com/teams/gitea" title = "Bountysource" >
2021-01-13 09:53:17 -06:00
< img src = "https://img.shields.io/bountysource/team/gitea/activity" >
< / a >
2021-01-01 13:04:35 -06:00
< / p >
2016-11-03 09:50:44 -05:00
2021-01-01 13:04:35 -06:00
< p align = "center" >
2022-07-14 06:15:35 -05:00
< a href = "README_ZH.md" > View this document in Chinese< / a >
2021-01-01 13:04:35 -06:00
< / p >
2014-03-13 01:55:14 -05:00
2014-02-12 11:49:46 -06:00
## Purpose
2017-08-29 20:27:23 -05:00
The goal of this project is to make the easiest, fastest, and most
painless way of setting up a self-hosted Git service.
2022-07-14 06:15:35 -05:00
As Gitea is written in Go, it works across **all** the platforms and
architectures that are supported by Go, including Linux, macOS, and
Windows on x86, amd64, ARM and PowerPC architectures.
You can try it out using [the online demo ](https://try.gitea.io/ ).
2017-08-29 20:27:23 -05:00
This project has been
[forked ](https://blog.gitea.io/2016/12/welcome-to-gitea/ ) from
2022-07-14 06:15:35 -05:00
[Gogs ](https://gogs.io ) since November of 2016, but a lot has changed.
2015-10-29 02:21:59 -05:00
2018-01-01 07:38:49 -06:00
## Building
2015-09-12 08:21:09 -05:00
2018-01-01 07:38:49 -06:00
From the root of the source tree, run:
2014-02-12 11:49:46 -06:00
2019-12-08 10:56:59 -06:00
TAGS="bindata" make build
2014-02-12 11:49:46 -06:00
2021-12-23 21:56:57 -06:00
or if SQLite support is required:
2020-01-28 20:30:02 -06:00
TAGS="bindata sqlite sqlite_unlock_notify" make build
2020-02-22 03:15:11 -06:00
The `build` target is split into two sub-targets:
2022-06-09 22:34:41 -05:00
- `make backend` which requires [Go Stable ](https://go.dev/dl/ ), required version is defined in [go.mod ](/go.mod ).
2021-11-18 10:45:00 -06: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 03:15:11 -06:00
2021-04-09 00:08:14 -05: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 03:15:11 -06:00
2021-04-09 00:08:14 -05:00
Parallelism (`make -j < num > `) is not supported.
2020-07-30 16:21:59 -05:00
2018-01-01 07:38:49 -06: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 19:18:28 -05:00
support with [documentation ](https://try.gitea.io/api/swagger ).
2014-02-12 11:49:46 -06:00
2016-11-28 07:34:06 -06:00
## Contributing
2018-01-01 07:38:49 -06: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 10:02:55 -05:00
## Translating
2022-07-27 20:22:47 -05:00
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.
2021-05-12 10:02:55 -05:00
Fix various typos (#20338)
* Fix various typos
Found via `codespell -q 3 -S ./options/locale,./options/license,./public/vendor -L actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon`
Co-authored-by: zeripath <art27@cantab.net>
2022-07-12 16:32:37 -05:00
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.
2021-05-12 10:02:55 -05:00
https://docs.gitea.io/en-us/translation-guidelines/
[](https://crowdin.com/project/gitea)
2018-01-01 07:38:49 -06:00
## Further information
2020-12-06 07:56:46 -06: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/ ).
2022-07-27 20:22:47 -05:00
We maintain a list of Gitea-related projects at [gitea/awesome-gitea ](https://gitea.com/gitea/awesome-gitea ).
The Hugo-based documentation theme is hosted at [gitea/theme ](https://gitea.com/gitea/theme ).
2020-12-06 07:56:46 -06:00
The official Gitea CLI is developed at [gitea/tea ](https://gitea.com/gitea/tea ).
2016-11-28 07:34:06 -06:00
## Authors
2022-07-27 20:22:47 -05:00
- [Maintainers ](https://github.com/orgs/go-gitea/people )
- [Contributors ](https://github.com/go-gitea/gitea/graphs/contributors )
- [Translators ](options/locale/TRANSLATORS )
2014-03-27 11:34:12 -05:00
2018-05-11 00:53:23 -05: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 >
2022-10-13 20:44:04 -05:00
< a href = "https://cynkra.com/" target = "_blank" > < img src = "https://images.opencollective.com/cynkra/logo/square/64/192.png" > < / a >
2018-05-11 00:53:23 -05:00
2018-06-04 19:15:32 -05: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 15:41:31 -05: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 11:34:12 -05:00
## License
2017-08-29 20:27:23 -05:00
This project is licensed under the MIT License.
2021-05-04 11:16:23 -05:00
See the [LICENSE ](https://github.com/go-gitea/gitea/blob/main/LICENSE ) file
2017-08-29 20:27:23 -05:00
for the full license text.
2018-06-08 19:13:41 -05:00
## Screenshots
2022-07-27 20:22:47 -05:00
2018-06-08 19:13:41 -05:00
Looking for an overview of the interface? Check it out!
2019-11-04 18:12:58 -06:00
||||
2018-06-08 19:13:41 -05:00
|:---:|:---:|:---:|
2019-11-04 18:12:58 -06:00
||||
|||
|||
