Skip to content

Latest commit

 

History

History
33 lines (30 loc) · 3.11 KB

README.md

File metadata and controls

33 lines (30 loc) · 3.11 KB
Raw

A text DSL and generator for different languages written in Groovy

The software is in alpha development stage, the documentation and examples will provided soon.

Getting started

Installation

  1. Install Gradle build system
  2. Install GGTS - Groovy/Grails Tool Suite or Groovy Eclipse Plugin in your eclipse desctribution
  3. Clone the ee-mdd GitHub repository in your Eclipse workspace, you can use Git Repository Exploring Eclipse perspective.
  4. Import ee-mdd Eclipse project from the repository into workspace with Import projects operation.
  5. Open terminal / console and change to the ee-mdd folder of your file system and execute gradle clean install and gradle cleanEclipse eclipse command which creates Eclipse projects files with dependencies to your local gradle repository. Do same step in ee-mdd-example folder
  6. Go to Eclipse, refresh the repository and import ee-mdd-core, ee-mdd-gradle, ee-mdd-templates and ee-mdd-example... Eclipse projects from the repository into workspace with Import projects operation.

Code generation

  • ModelBuilderExample.groovy is an example model written in the DSL
  • Main class GeneratorForJava.groovy to start generation of Java code from the model.
  • Main class GeneratorForJs.groovy to start generation of JavaScript code from the model.
  • The code will be generated into console and also into folder specified in fileProcessor - 'fileProcessor('D:/views/git/ee-mdd/ee-mdd-example')'. Please adjust it to absolute path of 'ee-mdd-example' project on your file system.

Set up GUI

  • For troubleshooting refer to gui-documentation.md
  • gui-example provides a generated and commented example - go to step 7 and treat "gui-example" like "ee-mdd_example-ui"
  1. Install XAMPP or another webserver of your choice
  • If you use a different webserver skip step 2 and replace {YourPathToXampp}/htdocs/ with your webserver's document root (e.g. /var/www/ for apache on linux)
  1. Configure it by starting the webserver (e.g. via xampp-control) and navigating to http://localhost (see XAMPP FAQs for help)
  2. After the configuration of xampp is done, it is recommended to backup your current htdocs-content outside the htdocs-folder.
  3. Clear your htdocs-folder (do not forget to backup --> Step 3!)
  4. Copy the content of /gui-dist to {YourPathToXampp}/htdocs/ (just the content, not the folder itself)
  5. Run GenerateJsTest.groovy (ee-mdd/ee-mdd-gradle/src/test/groovy/ee/mdd/gradle/task/) in eclipse
  6. Copy the files generated to ee-mdd/ee-mdd-gradle/temp/ee-mdd_example-ui to {YourPathToXampp}/htdocs/ (just the content, not the folder itself)
  7. Navigate to http://localhost to see the results
  8. When working with different versions you might want to create a subfolder in htdocs. You need to include all files (gui-dist + ee-mdd_example-ui) into the subfolders! After this go to http://localhost/{subfolder} to inspect it.