hrfee/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-11-22 10:20:11 +00:00
Code Issues Projects Releases Wiki Activity

Updated Build (markdown)

Harvey Tindall 2021-01-29 17:19:29 +00:00
parent 0fb81075e0
commit 806be2f9e8
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Build.md

@ -1,9 +1,9 @@
To build, you need to compile the typescript and sass, and generate email templates and config files. The build scripts were mostly ripped out of jf-accounts, so you'll need similar dependencies: To build, you need to compile the typescript and go, and generate email templates and config files. The build scripts were mostly ripped out of jf-accounts, so you'll need similar dependencies:
``` ```
git git
python >= 3.6 python >= 3.6
pip (to install libsass) go >= 1.15
node.js and npm (for tsc/esbuild, bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) node.js and npm (for tsc/esbuild and mjml)
upx (optional, to compress the executable) upx (optional, to compress the executable)
``` ```
The main dependencies of the program will be automatically downloaded on compilation and can be seen in [go.mod](https://github.com/hrfee/jfa-go/blob/main/go.mod) The main dependencies of the program will be automatically downloaded on compilation and can be seen in [go.mod](https://github.com/hrfee/jfa-go/blob/main/go.mod)
@ -13,6 +13,6 @@ A Makefile is provided, which requires the `make` command. Simply clone the repo
### Goreleaser ### Goreleaser
[goreleaser](https://github.com/goreleaser/goreleaser) is used to publish the packages seen in the release section. [goreleaser](https://github.com/goreleaser/goreleaser) is used to publish the packages seen in the release section.
* To generate executables for multiple platforms, run `goreleaser build --snapshot --rm-dist`. They will be stored in `dist/`. The `data` directory must be manually copied into the same directory as the executable for it to run. * To generate executables for multiple platforms, run `goreleaser build --snapshot --rm-dist`. They will be stored in `dist/`. The `data/` directory must be manually copied into the same directory as the executable for it to run.
* To generate package archives that include `data`, run `goreleaser --snapshot --skip-publish --rm-dist`. * To generate package archives that include `data`, run `goreleaser --snapshot --skip-publish --rm-dist`.