halogen-websocket-ipc-playzone/README.md

1.6 KiB

purescript-halogen-template

Dependency status

This is a template for starting a fresh project using the purescript-halogen library for declarative user interfaces.

Prerequisites

This guide assumes you already have Git and Node.js installed with npm somewhere on your path.

In the PureScript ecosystem Bower is currently the most commonly used package manager and we'll be relying on it for this project, so if you don't already have it, you can install it like this:

npm install --global bower

Getting started

First clone the repo and step into it:

git clone https://github.com/slamdata/purescript-halogen-template.git my-halogen-project
cd my-halogen-project

If you don't already have a global installation of the PureScript compiler and Pulp (or you want a local installation with the appropriate versions) you can run:

npm install

Finally you'll need to install the PureScript library dependencies for this project with Bower:

bower install

Building

The project can now be built with:

npm run build

This will build the PureScript source code and produce a bundled JS file as dist/app.js.

This is an alias for the Pulp command:

pulp build --to dist/app.js

If you open dist/index.html you should now have a basic working Halogen app.

That's pretty much it. Have fun with Halogen!