-
-
Notifications
You must be signed in to change notification settings - Fork 156
Installing the Generator
Rhys edited this page May 8, 2021
·
1 revision
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.
- Clone the repository from GitHub.
- Go into the directory and run
$ yarn install
to install all the dependencies required by the project - Run
$ yarn install-compiler
to download Tweego and the necessary files for it to work- If you are on a Linux based machine, you may need to run
$ chmod +x ./.twine/tweego
to enable the proper permission for tweego.
- If you are on a Linux based machine, you may need to run
- 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 theindex.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.