Installing the Generator - jmcomie/Eigengrau-s-Essential-Establishment-Generator GitHub Wiki

For online code editing, see the (similar but still distinct) Codespaces tutorial.

You will need a recent version of NodeJS, as well as Yarn, which you can install by running npm install -g yarn once you have NodeJS installed. Reboot after installing.

Installation:

1. Clone the repository from GitHub.
2. Go into the directory and run $ yarn install to install all the dependencies required by the project
3. Run $ yarn install-compiler to download Tweego and the necessary files for it to work
   1. If you are on a Linux based machine, you may need to run $ chmod +x ./.twine/tweego to enable the proper permission for tweego.
4. Run $ yarn start to watch for file changes or $ yarn build to build the files once.

• The entire thing will output to the /gh-pages folder as the index.html file.
• with yarn start you can just close and re-open the page after saving changes to the code, or use the restart inside the generator.