Skip to content

Latest commit

 

History

History
89 lines (70 loc) · 3.9 KB

README.md

File metadata and controls

89 lines (70 loc) · 3.9 KB
Raw

[Build Status]

Freon, previously know as ProjectIt

Projectional Editor for the Web. The current release (version 0.7.0-beta4) can be found on npm.

This beta release supports LionWeb (de)serialization. As LionWeb is in motion, expect this release to change according to LionWeb changes before it becomes final.

This release also supports external editor component, as an experimental feature.

What is Freon

Freon is a TypeScript/JavaScript framework to create and implement projectional editors for Domain-Specific Languages (DSLs). Additional to the core framework, there are generators for many parts of the work environment for your DSL.

For more information see the Freon website.

Developing Freon

The main prerequisites are: Node.js and npm. We are typically using the latest versions of both, although older versions likely work just as well.

Clone or fork this github project, check out the development branch, and install dependencies:

  git clone https://github.com/freon4dsl/Freon4dsl.git

Setup the multirepo and install all dependencies:

  npm install

Now you can build Freon with:

  npm run build

And run all tests with:

  npm run test

Starting the web app editor

  • Go to the package containing your language, this can e.g. be any package in packages/samples.

    • Build the language using npm run build

  • Go to the webapp-starter package.

    • Open the file `package.json
    • In the dependencies section change the language dependency to your chosen language
    • Also open the file src/starter.ts
    • Change lines 7 and 8 to import the correct environment from your chosen language package.

  • Go to directory packages/server and start the server:

    cd packages/server
    npm run start
  • Goto the webapp-starter and start Freon:
    cd packages/webapp-starter
    npm run prepare-app
    npm run dev

This will open a browser with the example from the samples/Example package on the URL displayed: http://localhost:5000/. The example and all other projects in samples are work in progress.

Source organisation

The source code for Freon is organised into the following packages.

  • docs: documentation, i.e. this website
  • packages/core: framework source code.
  • packages/core/src/editor: the editor framework source code.
  • packages/core/src/language/decorators: source code for MobX decorators that can be used to easily implement a language that can be directly used by Freon.
  • packages/meta: source code that reads the language definition files and generates the language environment.
  • packages/meta/src/languagedef: source code that generates code from a language structure definition (.ast) file.
  • packages/meta/src/editordef: source code that generates code from an editor definition (.edit) file.
  • packages/meta/src/scoperdef: source code that generates code from a scoper definition (.scope) file.
  • packages/meta/src/typerdef: source code that generates code from a typer definition (.type) file.
  • packages/meta/src/validatordef: source code that generates code from a validator definition (.valid) file.
  • packages/server: source code for a minimalistic model-server used for demonstration purposes.
  • packages/webapp-lib: source code for the web-application used for all generated languages.
  • packages/samples/: source code for a number of sample languages.
  • packages/webapp-starter/: source code for web app including one language. This package import the webapp-lib for the full web app and one language from samples to be used in the webapp.
  • /*: the usual suspects.