You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
libayatana-appindicator or equivalent (if building with tray icon on linux)
19
19
gcc-mingw-w64-x86-64 or equivalent (if cross-compiling for windows on linux/macOS)
@@ -36,7 +36,7 @@ A Makefile is provided, which requires the `make` command. Simply clone the repo
36
36
37
37
* You can optionally provide the path/name of the `go` executable manually with `make all GOBINARY=<path to go>`.
38
38
39
-
* More build-time variables exist, which are explained on the [contributing page](/docs/build/dev).
39
+
* More build-time variables exist, which are explained on the [contributing page](/docs/dev).
40
40
41
41
## Goreleaser
42
42
[goreleaser](https://github.com/goreleaser/goreleaser) is used to publish the packages seen in the release section. The `scripts/version.sh` wrapper generates the version and provides it to goreleaser with an environment variable.
Copy file name to clipboardExpand all lines: content/docs/dev.md
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -17,15 +17,17 @@ The Makefile is more suited towards development than other build methods, and pr
17
17
18
18
Prefix each of these with `make DEBUG=on `:
19
19
*`all` will download deps and build everything. The executable and data will be placed in `build`. This is only necessary the first time.
20
+
*`quick` skips a couple steps, namely `npm`, `swagger`, and `email` to make things a bit quicker when you're not working on that sorta stuff.
20
21
*`npm` will download all node.js build-time dependencies.
21
22
*`compile` will only compile go code into the `build/jfa-go` executable.
22
23
*`typescript` will compile typescript w/ sourcemaps into `build/data/web/js`.
23
24
*`bundle-css` will bundle CSS and place it in `build/data/web/css`.
24
-
*`inline` will inline the css and javascript used in the single-file crash report webpage.
25
+
*`inline-css` will inline the css and javascript used in the single-file crash report webpage.
25
26
*`configuration` will generate the `config-base.json` (used to render settings in the web ui) and `config-default.ini` and put them in `build/data`.
26
27
*`email` will compile email mjml, and copy the text versions in to `build/data`.
27
28
*`swagger`: generates swagger documentation for the API.
28
-
*`copy` will copy iconography, html, language files and static data into `build/data`.
29
+
*`variants-html` will copy over html files and runs the `missings-colors.js` script to insert missing dark mode tags.
30
+
*`copy` will copy iconography, language files and other static data into `build/data`.
29
31
30
32
## Environment variables
31
33
@@ -37,6 +39,7 @@ Prefix each of these with `make DEBUG=on `:
37
39
*`GOBINARY=<path to go>`: Alternative path to go executable. Useful for testing with unstable go releases.
38
40
*`VERSION=v<semver>`: Alternative verision number, useful to test update functionality.
39
41
*`COMMIT=<short commit>`: Self explanatory.
42
+
*`BUILDTIME=<unix timestamp>`: Build timestamp to be shown in "About", and used for update detection.
40
43
*`LDFLAGS=<ldflags>`: Passed to `go build -ldflags`.
41
44
*`E2EE=on/off`: Enable/disable end-to-end encryption support for Matrix, which is currently very broken. Must subsequently be enabled (with Advanced settings enabled) in Settings > Matrix.
42
45
*`TAGS=<tags>`: Passed to `go build -tags`.
@@ -47,4 +50,4 @@ Prefix each of these with `make DEBUG=on `:
47
50
48
51
Static Web API docs can be accessed by clicking [Web API Docs](https://api.jfa-go.com) on the sidebar or here.
49
52
50
-
A live version of the swagger documentation is available by running jfa-go with the `-swagger` argument to make it available at `http://localhost:8056/swagger/index.html`. If you're introducing any new routes when working on the API, make sure to give them a proper description above the function (see other routes in `api.go` as well as the [swaggo](https://github.com/swaggo/swag) documentation), and to put it in the appropriate category. If a struct used as a parameter or return type needs explanation, put descriptions of each field as a comment next to it (see [models.go](https://github.com/hrfee/jfa-go/blob/main/models.go)).
53
+
A live version of the swagger documentation is available by running jfa-go with the `-swagger` argument to make it available at `http://localhost:8056/swagger/index.html`. If you're introducing any new routes when working on the API, make sure to give them a proper description above the function (see other routes in `api.go` as well as the [swaggo](https://github.com/swaggo/swag) documentation), and to put it in the appropriate category and/or file (e.g. `api-discord.go` for a discord-only method). If a struct used as a parameter or return type needs explanation, put descriptions of each field as a comment next to it (see [models.go](https://github.com/hrfee/jfa-go/blob/main/models.go)).
0 commit comments