kylefinley / elm-platform

Bundle of all core development tools for Elm

Elm Platform

A bundle of all Elm tools: elm, elm-reactor, elm-repl, and elm-get.

Getting Started

After installing, use this starter project to get comfortable using Elm and all of its tools.

Be sure to try out the time-traveling debugger with elm-reactor!

Installers

Update to a newer version of Elm by just running the installer again. They link to the latest versions, and they will safely overwrite old executables and paths so your machine is in a consistent state.

If you have any trouble installing, open an issue on this repo and then consider using the platform agnostic install path which works on any OS, but will take a while longer.

Mac

Use the Mac installer. Run this script if you ever want to uninstall.

Windows

Use the Windows installer.

Arch Linux

Follow these directions.

Platform Agnostic Install

The following instructions should work on any platform, from Windows to Ubuntu. It builds the compiler from source in a relatively straight-forward way, but it will still take some time to run.

1. Download the Haskell Platform. We will use this to build the Elm Platform.

2. Choose a directory to build the Elm Platform. On Linux and Mac a good place is /usr/local/. On Windows a good place is C:\Program Files\. The rest of the instructions will assume you are using /usr/local/ just to make things a bit simpler.

3. In /usr/local/ create a directory named Elm-Platform/0.13/

4. Run the following commands from within /usr/local/Elm-Platform/0.13/

    cabal sandbox init
    cabal update
    cabal install -j Elm-0.13 elm-repl-0.3 elm-reactor-0.1 elm-get-0.1.3

This will take some time. Upon finishing successfull, it will place all of
the executables you need in a directory called `bin/`.

5. On Mac or Linux, add /usr/local/Elm-Platform/0.13/bin to your PATH. On Windows, add C:\Program Files\Elm-Platform\0.13\bin to your PATH. This makes it so you can run elm-repl or elm-reactor from anywhere on your computer.

This approach makes it easy to have multiple versions of Elm Platform installed. It is okay to have Elm-Platform/0.12.3, Elm-Platform/0.13, and many others. It is up to you to manage your PATH though.

Help

If you are stuck, check to see if anyone has had a similar issue. If not, open a new issue or email the list or ask a question in the #Elm IRC channel.