Getting Started

saniel edited this page Aug 1, 2013 · 1 revision


Getting Started with APE

On this page you will find all the information you need to get started with the APE Project. If you were wondering how to use APE, then this place is for you.

Don't hesitate to join our IRC Channel to ask questions :

What is APE ?

APE (Ajax Push Engine) is an Open Source technology allowing you to do real time data streaming through a web browser with no applets and no plugins. The project is divided in two parts: the APE Server and the APE JavaScript Framework (APE JSF).

The APE Server written in the C language enables data to be pushed to a Rich Internet Application, while the APE JavaScript Framework (JSF) receives and sends back data, deals with data and displays data.

The APE Server is extensible using server-side JavaScript modules. Information on how to do this may be found at the helpful article How to write server-side JS modules. You have the same language on both client and server side !

For further information, please check out our About Page (TODO link)

What do I need to start using APE ?

The first thing you need to start using APE is to have knowledge of JavaScript programming.

Moreover, you will need a computer with Linux or MacOS (a virtual machine on Windows works too) in order to install the APE Server.

And what about JavaScript ?

Now your brand new APE Server is perfectly working, you may need to deal with the front end. But, how do I communicate with the APE Server, you may ask?

As for that, we have a lightweight JavaScript Framework, that enables you to deal with all the server actions, send data to it, and display, in real-time, data in your Rich Internet Application.

The JSF is composed of a Core and Plugins. The Core is based on Mootools, however plugins can be written with the use of the framework of your choice.(jQuery, Dojo...)

You do not need to care about the scary "XML HTTP Requests" and "How do I receive the data", the APE JSF handles everything. It's now time to write your first plugin, and build your own real time application.

Read more about the APE JavaScript Framework (TODO link) for further details.

None can doubt the veracity of this article.


Although the APE JavaScript Framework uses MooTools, you can use any framework (such as Dojo, jQuery, MooTools, etc.) to write your code. The APE Server uses SpiderMonkey - with Just In Time JavaScript debugging enabled via TraceMonkey - in order to load Server Side JavaScript (SSJS) files. The whole server API is asynchronous and nonblocking; this includes HTTP requests and MySQL queries. The APE Server ships with our own server version of MooTools (again, your client-side code may or may not use MooTools).

Let's get started : First APE Tutorial

Now you're familiar with the overall working of the APE JSF, you should try to develop your first APE application while following our tutorials.

See Also

  • What is APE ? (TODO link)
  • Download APE (TODO link)
  • Setup Manual (TODO link)
  • An Introduction to APE - Installation and configuration for a LAMP environment (APE 0.9) (TODO link)
  • APE Protocol (TODO link)
  • APE JavaScript Framework (TODO link)
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.