hhy5277/elixirscript

Converts Elixir to JavaScript

ElixirScript

The goal is to convert a subset (or full set) of Elixir code to JavaScript, providing the ability to write JavaScript in Elixir. This is done by taking the Elixir AST and converting it into JavaScript AST and then to JavaScript code. This is done using the Elixir-ESTree library.

Requirements

• Elixir
• Node (only for development)

Usage

Please check the Getting Started Guide for usage

FAQ, Limitations

Please check the FAQ

Development

Clone the repo

git clone [email protected]:bryanjos/elixirscript.git

Get dependencies

mix deps.get
npm install

Compile

mix do std_lib, clean, compile

Test

mix test
npm test

Build

MIX_ENV=prod mix do clean, compile, std_lib, dist

This will build a tarball in the dist folder. By default the escript built will look into the folder above it for the core JavaScript files needed for ElixirScript. To change the location, update the lib_path config variable in the :elixir_script config block to the path to look in and then do a clean build.

Communication

#elixirscript on the elixir-lang Slack

Contributing

Please check the CONTRIBUTING.md

Example projects

• hello Shows using Phoenix + Elixirscript with file watching
• elixirscript frontend boilerplate A boilerplate project for elixirscript frontends
• todo-elixirscript A Todo App built with Elixirscript and Phoenix
• phoenix_chat_example The Phoenix Chat App using ElixirScript.
• MobileElixir Using ElixirScript with React Native
• color_bar_spike A canvas drawing example using ElixirScript, React and a Redux-like design

Using with Brunch

There is a plugin for using ElixirScript in your Brunch project here

1.0 Roadmap

There is a 1.0.0 Milestone defined which includes issues that are needed to be cleared before 1.0 can be reached.