foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-22 22:17:10 -05:00
Code Issues Activity

Add page to document how to set up a dev environment

Browse source
This commit is contained in:
Antonin Delpeuch 2023-12-04 14:40:57 +01:00 committed by Earl Warren
parent 54a3207eb3
commit b8e37e4237
2 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
docs/developer/development-environment.md Normal file
View file

@ -0,0 +1,44 @@
---
title: 'Development environment'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/ec1feedbf582b05b6a5e8c59fb2457f25d053ba2/docs/content/development/hacking-on-gitea.en-us.md'
---
This page lists a few options to set up a productive development environment for working on Forgejo.
## VS Codium
[VS Codium](https://vscodium.com/) is an open source version of the Visual Studio Code IDE.
The [Go integration for Visual Studio Code](https://code.visualstudio.com/docs/languages/go) works
with VS Codium and is a viable tool to work on Forgejo.
First, run `cp -r contrib/ide/vscode .vscode` to create new directory `.vscode` with the contents of folder [contrib/ide/vscode](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/contrib/ide/vscode) at the root of the repository. Then, open the project directory in VS Codium.
You can now use `Ctrl`+`Shift`+`B` to build the gitea executable and `F5` to run it in debug mode.
Tests can be run by clicking on the `run test` or `debug test` button above their declaration.
Go code is formatted automatically when saved.
## Emacs
Emacs has [a Go mode](https://github.com/dominikh/go-mode.el) that can likely be used to work on Forgejo's code base.
Do you know how to configure it properly? Why not document that here?
## Vim
Vim has [a Go plugin](https://github.com/fatih/vim-go) that can likely be used to work on Forgejo's code base.
Do you know how to configure it properly? Why not document that here?
## GoLand
Clicking the `Run Application` arrow on the function `func main()` in `/main.go`
can quickly start a debuggable Gitea instance.
The `Output Directory` in `Run/Debug Configuration` MUST be set to the
gitea project directory (which contains `main.go` and `go.mod`),
otherwise, the started instance's working directory is a GoLand's temporary directory
and prevents Gitea from loading dynamic resources (eg: templates) in a development environment.
To run unit tests with SQLite in GoLand, set `-tags sqlite,sqlite_unlock_notify`
in `Go tool arguments` of `Run/Debug Configuration`.

1
docs/developer/index.md
View file

@ -12,6 +12,7 @@ their needs.
- [Sustainability and funding](https://codeberg.org/forgejo/sustainability)
- For contributors
- [Compiling from source](./from-source/)
- [Development environment](./development-environment/)
- [Interface customization](./customization/)
- [Architecture overview](./architecture/)
- [Developer Certificate of Origin (DCO)](./dco/)