diff --git a/Build.md b/Build.md index 864a89f..09ff696 100644 --- a/Build.md +++ b/Build.md @@ -1,11 +1,13 @@ -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: +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: ``` git python >= 3.6 pip (to install libsass) -node.js and npm (for bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) +node.js and npm (for tsc, bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) 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) + ### Makefile A Makefile is provided, which requires the `make` command. Simply clone the repository and run `make all` (or `make headless` for a non-interactive mode) to grab all necessary dependencies for go/python/node, compile everything and place the executable and app data inside `build/`. You can optionally compress the executable by running `make compress` after.