Getting Started

Introduction

Aerial Framework is comprised of two fundamental components: a client-side component and a server-side component. Everything you need to get started is in the Git repository. You can download the source in a number of ways:

• by cloning the git repository

  • The URL for the Aerial Framework core repository is [email protected]:aerial-framework/core.git. Installation instructions for Git are available on GitHub for Mac, Windows and Linux.

• or by downloading the source as a ZIP or tarball:

  • ZIP: https://github.com/aerial-framework/core/zipball/master
  • Tarball: https://github.com/aerial-framework/core/tarball/master

Framework Structure

Once you have downloaded the source code for the project, you will find the source to have the following structure:

• Plugins
  • MySQL Workbench
    • AerialExport.grt.lua - the Lua plugin used in MySQL Workbench to export a schema to YAML
• src_flex
  • com
    • hurlant - contains the as3crypto library
  • org
    • aerial - contains the client-side Aerial code
• src_php
  • config - contains the configurable elements of Aerial
  • lib - contains all the libraries used by Aerial on the server
  • public_html - this is the project's webroot and contains the amfPHP library and server entrypoint
• LICENSE - 3 guesses at what this is
• project.xml - Project descriptor file

Set up

Now that we have our source, you can create a new project in your favourite IDE. In this article, we'll be focusing on Flash Builder 4.

1: Create a new Flex project:

2: Set up the server

The values for the "Web Root" and the "Root URL" must pertain to your own web root and root URL - the values provided are sample values. The "Output folder" path you can copy as it is.

3: Set up the Flex build options

Flash Builder will (rather annoyingly) create a "src" folder for you. You can delete this folder and instead use the "src_flex" folder as your "Main source folder".

4: Click Finish and you're ready to rock and roll!

Next step: Configuring the Server