1
0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-11-24 11:20:10 +00:00

Build instructions added

Harvey Tindall 2020-08-02 02:26:08 +01:00
commit 07c235a76a

14
Build.md Normal file

@ -0,0 +1,14 @@
To build, you need to generate email templates, css, and config files. The build scripts were mostly ripped out of jf-accounts, so you'll need similar dependencies:
```
python >= 3.6
pip (to install libsass)
node.js and npm (for bootstrap4/5, autoprefixer, cleancss, mjml, and postcss)
```
If you aren't using [goreleaser](https://goreleaser.com), run each command listed under `before: hooks:` in `.goreleaser.yml`, then `go build`.
If you are:
* To generate executables, run `goreleaser build --snapshot --rm-dist`. This will place executables in `dist/`. The `data` directory must be copied into the same directory as the executable for it to run.
* To generate package archives, run `goreleaser --snapshot --skip-publish --rm-dist`.