Pages.jl

This is a package designed to help get started with web APIs and some basic interaction between Julia and a browser.

Installation

To get the latest tagged version, try:

pkg> add Pages

However, this package is still in early development and is likely to change often. To get the latest, try:

pkg> add Pages#master

Introduction

To get started, try the following:

julia> using Pages

julia> @async Pages.start();
Listening on 0.0.0.0:8000...

This starts a server that is listening at http://localhost:8000 and exposes the Endpoint type with a few methods.

To create an Endpoint, try:

julia> Endpoint("/hello") do request::HTTP.Request
          "Hello world"
       end

This creates a web page at http://localhost:8000/hello that says Hello world.

One nice thing about using Pages is that we can create pages whenever and wherever we want in our Julia code even while the server is running.

Examples

There are a few examples included. The fastest way to see the examples is to run:

julia> Pages.examples(launch=true);

This will start a server and launch a browser open to a page with links to some simple examples. If you prefer not to open a browser to the page from the command line, you can instead run

julia> Pages.examples();

and then navigate to http://localhost:8000/examples.

Current examples include:

Requests - Send GET and POST requests from the browser to Julia and print the contents to the REPL.
Blank - You can use this for experimemntation, e.g. use Pages.add_library to insert your favorite JavaScript library.
Random Ping - For this example, click the "Blank" link and run

julia> Pages.Examples.randomping.start()

This puts you into an infinite loop inserting text to the webpage.

To stop the example, run

julia> Pages.Examples.randomping.stop()

Documentation

This package is sorely lacking documentation, but some of the additional features were recently explained on Discourse:

Sending a message to a webpage on event

Acknowledgements