Skip to content
No description or website provided.
Find file
Pull request Compare This branch is 3868 commits behind elm-lang:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
core-js
src
Elm.cabal
LICENSE
README
README.md
Setup.hs
elm-mini.js

README.md

Elm

This is the Elm compiler and server, allowing you to develop Elm applications that run in any modern browser.

Installation Process

Download the Haskell Platform. This will give you access to the Haskell compiler (needed to build Elm) and Haskell's package distribution system (to make installation of Elm easier). Once installed (even if it already was), you must update your listing of Haskell packages with:

cabal update

This will ensure that the elm package is available. Then install Elm with:

cabal install elm

Assuming everything goes correctly (potential problems are discussed later), this will build two executables on your machine:

  • elm :: A standard compiler that takes .elm files and produces .html files. You can then use these HTML files with your favorite web-framework.

  • elm-server :: This is both a compiler and server, allowing you to develop without designing and setting up a server yourself. Running the "elm-server" program starts a server in the current directory. It will compile and serve any .elm files in the current directory and its sub-directories. This is how I prefer to develop Elm programs.

To use these executables you need to add a new directory to your PATH. For me, the executables were placed in /home/evan/.cabal/bin which I appended to the end of my PATH variable in my .bashrc file. Cabal should tell you where your executables are located, so you can make a similar addition (see this tutorial if you are new to changing your PATH in Unix/Linux).

That is almost everything. Create a new directory and navigate into it. Download the elm-mini.js file which is the Elm runtime system. It is separate from the compiler for now. You can use the command

wget https://raw.github.com/evancz/Elm/master/elm-mini.js

to download "elm-mini.js" from the command line. In the same directory, create the file "main.elm" with the contents:

main = lift asText Mouse.position

Now start up "elm-server" in this directory and navigate to your localhost. You should see a directory listing. Navigate to "main.elm" to see your first Elm program in action! Remember that "elm-mini.js" must be in the same directory as "main.elm".

Areas for further work:

Error messages need work in general. Syntax and Parsing errors are reported, but the messages are not very helpful. Type errors currently go unreported. I hope to fix this as soon as possible.

If you are interested in contributing, please contact me at info (at) elm-lang (dot) org.

Potential problems and their solutions:

  • On Windows, HAppStack has trouble installing because of issues with the "network" package. I struggled with this problem on Windows 7 until I found the suggestion at the bottom of this page.
  • When installing on Debian, "blaze-html-0.4.3.2" fails to compile. You must install "blaze-html-0.4.3.1" instead.
  • Likely more to come...
Something went wrong with that request. Please try again.