An empty template for a project using Freon. This template is used by create-freon.

To create a Freon project based on this template use

npm create freon --latest

The template project provides a shell for the generated editor that enables the user to work with multiple models and model units.

For an explanation of the content of the project see Project Structure.

In the following the root of the project will be indicated with '~'.

npm install

The npm create freon command already performs this action, so you only need to do this again when you change the dependencies in the package.json. file.

Run the generator and see the generated files appearing in the folder where you decided to store the generated code:

    npm run generate

The npm create freon command already performs this action, so you only need to do this again when you change anything in the defs folder.

Open a second terminal and start the server:

npm run server

Note that anything that is saved in the editor will be stored in ~/modelstore

Open another (bash) terminal, and start the generated editor from it:

npm run prepare-app
npm run dev

The first (prepare-app) command only needs to be done once, and only needs to be run again if you change the styling.

The last command opens your preferred browser with the generated editor for the language on localhost:5000.

If you are having trouble using the editor, have a look at the key-bindings under the Help menu.

If you change the theme, run npm run prepare-app to update the running app with the new style.