mirror of
https://github.com/go-gitea/gitea
synced 2024-06-02 01:15:48 +00:00
2ed9ead6de
* Add frontend/backend make targets, fix source release - Add 'make backend' and 'make frontend' make targets which are used to build go and js/css/svg files respectively. - The 'backend' target can be invoked without requiring Node.js to be present on the system if pre-built frontend assets are present like in the release source tarballs. - Fix source releases missing 'dist' folders inside 'node_modules' which were erronously excluded from tar. - Store VERSION in file VERSION for the release tarballs and prefer that file over git-derived version. * fix release task * fix typo * fix another typo
126 lines
6.7 KiB
Markdown
126 lines
6.7 KiB
Markdown
[简体中文](README_ZH.md)
|
||
|
||
<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>
|
||
|
||
[](https://drone.gitea.io/go-gitea/gitea)
|
||
[](https://discord.gg/NsatcWJ)
|
||
[](https://microbadger.com/images/gitea/gitea "Get your own image badge on microbadger.com")
|
||
[](https://codecov.io/gh/go-gitea/gitea)
|
||
[](https://goreportcard.com/report/code.gitea.io/gitea)
|
||
[](https://godoc.org/code.gitea.io/gitea)
|
||
[](https://github.com/go-gitea/gitea/releases/latest)
|
||
[](https://www.codetriage.com/go-gitea/gitea)
|
||
[](https://opencollective.com/gitea)
|
||
[](https://opensource.org/licenses/MIT)
|
||
[](https://crowdin.com/project/gitea)
|
||
|
||
## Purpose
|
||
|
||
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
|
||
[Gogs](https://gogs.io) since 2016.11 but changed a lot.
|
||
|
||
## Building
|
||
|
||
From the root of the source tree, run:
|
||
|
||
TAGS="bindata" make build
|
||
|
||
or if sqlite support is required:
|
||
|
||
TAGS="bindata sqlite sqlite_unlock_notify" make build
|
||
|
||
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
|
||
|
||
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
|
||
support with [documentation](https://try.gitea.io/api/swagger).
|
||
|
||
## Contributing
|
||
|
||
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/)!
|
||
|
||
## Authors
|
||
|
||
* [Maintainers](https://github.com/orgs/go-gitea/people)
|
||
* [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
|
||
* [Translators](options/locale/TRANSLATORS)
|
||
|
||
## 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>
|
||
|
||
## FAQ
|
||
|
||
**How do you pronounce Gitea?**
|
||
|
||
Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
|
||
|
||
**Why is this not hosted on a Gitea instance?**
|
||
|
||
We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
|
||
|
||
## License
|
||
|
||
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.
|
||
|
||
## Screenshots
|
||
Looking for an overview of the interface? Check it out!
|
||
|
||
||||
|
||
|:---:|:---:|:---:|
|
||
||||
|
||
|||
|
||
|||
|