code.gitea.io/gitea@v1.21.7/README.md (about)

     1  <p align="center">
     2    <a href="https://gitea.io/">
     3      <img alt="Gitea" src="https://raw.githubusercontent.com/go-gitea/gitea/main/public/assets/img/gitea.svg" width="220"/>
     4    </a>
     5  </p>
     6  <h1 align="center">Gitea - Git with a cup of tea</h1>
     7  
     8  <p align="center">
     9    <a href="https://drone.gitea.io/go-gitea/gitea" title="Build Status">
    10      <img src="https://drone.gitea.io/api/badges/go-gitea/gitea/status.svg?ref=refs/heads/main">
    11    </a>
    12    <a href="https://discord.gg/Gitea" title="Join the Discord chat at https://discord.gg/Gitea">
    13      <img src="https://img.shields.io/discord/322538954119184384.svg">
    14    </a>
    15    <a href="https://app.codecov.io/gh/go-gitea/gitea" title="Codecov">
    16      <img src="https://codecov.io/gh/go-gitea/gitea/branch/main/graph/badge.svg">
    17    </a>
    18    <a href="https://goreportcard.com/report/code.gitea.io/gitea" title="Go Report Card">
    19      <img src="https://goreportcard.com/badge/code.gitea.io/gitea">
    20    </a>
    21    <a href="https://pkg.go.dev/code.gitea.io/gitea" title="GoDoc">
    22      <img src="https://pkg.go.dev/badge/code.gitea.io/gitea?status.svg">
    23    </a>
    24    <a href="https://github.com/go-gitea/gitea/releases/latest" title="GitHub release">
    25      <img src="https://img.shields.io/github/release/go-gitea/gitea.svg">
    26    </a>
    27    <a href="https://www.codetriage.com/go-gitea/gitea" title="Help Contribute to Open Source">
    28      <img src="https://www.codetriage.com/go-gitea/gitea/badges/users.svg">
    29    </a>
    30    <a href="https://opencollective.com/gitea" title="Become a backer/sponsor of gitea">
    31      <img src="https://opencollective.com/gitea/tiers/backers/badge.svg?label=backers&color=brightgreen">
    32    </a>
    33    <a href="https://opensource.org/licenses/MIT" title="License: MIT">
    34      <img src="https://img.shields.io/badge/License-MIT-blue.svg">
    35    </a>
    36    <a href="https://gitpod.io/#https://github.com/go-gitea/gitea">
    37    <img
    38      src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod"
    39      alt="Contribute with Gitpod"
    40    />
    41    </a>
    42    <a href="https://crowdin.com/project/gitea" title="Crowdin">
    43      <img src="https://badges.crowdin.net/gitea/localized.svg">
    44    </a>
    45    <a href="https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea&branch=main" title="TODOs">
    46      <img src="https://badgen.net/https/api.tickgit.com/badgen/github.com/go-gitea/gitea/main">
    47    </a>
    48    <a href="https://app.bountysource.com/teams/gitea" title="Bountysource">
    49      <img src="https://img.shields.io/bountysource/team/gitea/activity">
    50    </a>
    51  </p>
    52  
    53  <p align="center">
    54    <a href="README_ZH.md">View this document in Chinese</a>
    55  </p>
    56  
    57  ## Purpose
    58  
    59  The goal of this project is to make the easiest, fastest, and most
    60  painless way of setting up a self-hosted Git service.
    61  
    62  As Gitea is written in Go, it works across **all** the platforms and
    63  architectures that are supported by Go, including Linux, macOS, and
    64  Windows on x86, amd64, ARM and PowerPC architectures.
    65  You can try it out using [the online demo](https://try.gitea.io/).
    66  This project has been
    67  [forked](https://blog.gitea.com/welcome-to-gitea/) from
    68  [Gogs](https://gogs.io) since November of 2016, but a lot has changed.
    69  
    70  ## Building
    71  
    72  From the root of the source tree, run:
    73  
    74      TAGS="bindata" make build
    75  
    76  or if SQLite support is required:
    77  
    78      TAGS="bindata sqlite sqlite_unlock_notify" make build
    79  
    80  The `build` target is split into two sub-targets:
    81  
    82  - `make backend` which requires [Go Stable](https://go.dev/dl/), the required version is defined in [go.mod](/go.mod).
    83  - `make frontend` which requires [Node.js LTS](https://nodejs.org/en/download/) or greater.
    84  
    85  Internet connectivity is required to download the go and npm modules. 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.
    86  
    87  Parallelism (`make -j <num>`) is not supported.
    88  
    89  More info: https://docs.gitea.com/installation/install-from-source
    90  
    91  ## Using
    92  
    93      ./gitea web
    94  
    95  NOTE: If you're interested in using our APIs, we have experimental
    96  support with [documentation](https://try.gitea.io/api/swagger).
    97  
    98  ## Contributing
    99  
   100  Expected workflow is: Fork -> Patch -> Push -> Pull Request
   101  
   102  NOTES:
   103  
   104  1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
   105  2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
   106  
   107  ## Translating
   108  
   109  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.
   110  
   111  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.
   112  
   113  https://docs.gitea.com/contributing/localization
   114  
   115  [![Crowdin](https://badges.crowdin.net/gitea/localized.svg)](https://crowdin.com/project/gitea)
   116  
   117  ## Further information
   118  
   119  For more information and instructions about how to install Gitea, please look at our [documentation](https://docs.gitea.com/).
   120  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/).
   121  
   122  We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea).
   123  
   124  The official Gitea CLI is developed at [gitea/tea](https://gitea.com/gitea/tea).
   125  
   126  ## Authors
   127  
   128  - [Maintainers](https://github.com/orgs/go-gitea/people)
   129  - [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
   130  - [Translators](options/locale/TRANSLATORS)
   131  
   132  ## Backers
   133  
   134  Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
   135  
   136  <a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
   137  
   138  ## Sponsors
   139  
   140  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)]
   141  
   142  <a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
   143  <a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
   144  <a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
   145  <a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
   146  <a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
   147  <a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
   148  <a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
   149  <a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
   150  <a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
   151  <a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
   152  
   153  ## FAQ
   154  
   155  **How do you pronounce Gitea?**
   156  
   157  Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
   158  
   159  **Why is this not hosted on a Gitea instance?**
   160  
   161  We're [working on it](https://github.com/go-gitea/gitea/issues/1029).
   162  
   163  ## License
   164  
   165  This project is licensed under the MIT License.
   166  See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file
   167  for the full license text.
   168  
   169  ## Screenshots
   170  
   171  Looking for an overview of the interface? Check it out!
   172  
   173  |![Dashboard](https://dl.gitea.com/screenshots/home_timeline.png)|![User Profile](https://dl.gitea.com/screenshots/user_profile.png)|![Global Issues](https://dl.gitea.com/screenshots/global_issues.png)|
   174  |:---:|:---:|:---:|
   175  |![Branches](https://dl.gitea.com/screenshots/branches.png)|![Web Editor](https://dl.gitea.com/screenshots/web_editor.png)|![Activity](https://dl.gitea.com/screenshots/activity.png)|
   176  |![New Migration](https://dl.gitea.com/screenshots/migration.png)|![Migrating](https://dl.gitea.com/screenshots/migration.gif)|![Pull Request View](https://image.ibb.co/e02dSb/6.png)
   177  ![Pull Request Dark](https://dl.gitea.com/screenshots/pull_requests_dark.png)|![Diff Review Dark](https://dl.gitea.com/screenshots/review_dark.png)|![Diff Dark](https://dl.gitea.com/screenshots/diff_dark.png)|