Skip to content

Commit ef4550f

Browse files
Add forkana specific installation section (#52)
* Update README.md Signed-off-by: Dan <[email protected]> * Add app ini details * Add work path comment * add go comment * Add pnpm installation instruction * Improve go info * Tweak comment * Tweak * Remove accidentally added file * Remove accidentally added file * Remove accidentally added file * Move indented to fenced * Fix indent --------- Signed-off-by: Dan <[email protected]>
1 parent 48c8e20 commit ef4550f

File tree

1 file changed

+81
-3
lines changed

1 file changed

+81
-3
lines changed

README.md

Lines changed: 81 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,78 @@
22

33
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/okTurtles/forkana)
44

5+
## Getting started
6+
7+
### Prerequisites
8+
9+
- Go 1.25. See https://go.dev/doc/manage-install
10+
- node
11+
- pnpm
12+
13+
### Installation
14+
15+
Add `gitea/custom/conf/app.ini`. See details below for file content. Make sure to properly set `WORK_PATH`.
16+
17+
<details>
18+
19+
```ini
20+
WORK_PATH = /path/to/forkana ; the only line which needs modification
21+
22+
[server]
23+
PROTOCOL = http
24+
DOMAIN = localhost
25+
HTTP_PORT = 3000
26+
ROOT_URL = http://localhost:3000/
27+
RUN_MODE = dev
28+
; LANDING_PAGE = explore
29+
30+
[database]
31+
DB_TYPE = sqlite3
32+
PATH = data/gitea.db
33+
34+
[security]
35+
INSTALL_LOCK = true
36+
SECRET_KEY = changeme
37+
INTERNAL_TOKEN = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE3NTY3NDU2NjZ9.luRdwGyyCdO0dyjghYinzVgC7Uu8JXTlst2HkrjE80k
38+
39+
[oauth2]
40+
JWT_SECRET = 9l225INhfQSZkuiCA1bu3rDvR3TDf6DckPy0m3qAGmE
41+
42+
[ui]
43+
DEFAULT_THEME = gitea-light
44+
EXPLORE_PAGING_DEFAULT_SORT = alphabetically
45+
```
46+
47+
</details>
48+
49+
Then run
50+
51+
```bash
52+
$ pnpm install
53+
```
54+
55+
To build the project:
56+
57+
```bash
58+
$ TAGS="bindata sqlite sqlite_unlock_notify" make build
59+
```
60+
61+
Note that it might be necessary, depending on your system's configuration, to prepend a `GO` specification (indicating the name of the executable, if different from just `go`).
62+
63+
```bash
64+
$ GO=go1.25.2 TAGS="bindata sqlite sqlite_unlock_notify" make build
65+
```
66+
67+
To run the project:
68+
69+
```bash
70+
$ TAGS="sqlite sqlite_unlock_notify" make watch
71+
```
72+
73+
Note that you need to build once in any case, before running continuously with watch.
74+
75+
Finally, visit http://localhost:3000 and you are ready to go to fork with Forkana!
76+
577
-----------
678

779
# Gitea
@@ -49,11 +121,15 @@ If you have any suggestions or would like to contribute to it, you can visit the
49121

50122
From the root of the source tree, run:
51123

52-
TAGS="bindata" make build
124+
```
125+
TAGS="bindata" make build
126+
```
53127

54128
or if SQLite support is required:
55129

56-
TAGS="bindata sqlite sqlite_unlock_notify" make build
130+
```
131+
TAGS="bindata sqlite sqlite_unlock_notify" make build
132+
```
57133

58134
The `build` target is split into two sub-targets:
59135

@@ -68,7 +144,9 @@ More info: https://docs.gitea.com/installation/install-from-source
68144

69145
After building, a binary file named `gitea` will be generated in the root of the source tree by default. To run it, use:
70146

71-
./gitea web
147+
```
148+
./gitea web
149+
```
72150

73151
> [!NOTE]
74152
> If you're interested in using our APIs, we have experimental support with [documentation](https://docs.gitea.com/api).

0 commit comments

Comments
 (0)