Install Node. Currently builds with Node v12.13.0 (npm v6.12.0)
Install Packages: npm -f install
Note: may have to rebuild node-sass after npm installs: npm rebuild node-sass
To retrieve the secrets file, install ansible
- place a copy
vault-password.txtinto the root of this repo~/flood. You might need to change spaces to newlines. cd into the root folder and runmake pull-secretsto quickly download, decrypt, and properly place the secrets file.- Alternatively (without ansible), make a copy of
src/keys/secrets.sample.es, fill out and save assrc/keys/secrets.es
- Alternatively (without ansible), make a copy of
npm startto start a hot-reloading development web server. First time starting, may require you create the empty directorydistin the project root.- Open browser to
http://localhost:3545
npm run testwill run the Mocha Test suite
npm run distwill produce a production build in the/dist/folder
Prod Note: if you receive a permission error (./node_modules/webpack/bin/webpack.js: Permission denied) when running the production dist command, run npm rebuild and try again
https://realfavicongenerator.net/
- Favicon.ico is converted to PNG format and then uploaded to the realfavicongenerator. Should be a minimum pixel size of 144x144. This generator will offer numerous options for specific shortcut icons and favicons for a multitude of devices.
- Go through the settings and tweak the various ones as necessary.
- Be sure to declare the 'path' in the last settings option ("Favicon Generator Options") to be
/icons. Then click to Generate - After generation is complete, download the Favicon Package and use it to replace the images within
/src/images/icons. Then copy the HTML code and use it to replace the pre-existing image code within/src/index.njk