Skip to content

elixirscript/elixirscript

Repository files navigation

ElixirScript Documentation Build Deps Status Join the chat at https://gitter.im/elixirscript/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

  • Erlang 20 or greater
  • Elixir 1.5 or greater (must be compiled with Erlang 20 or greater)
  • 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
yarn

Create Elixir.Bootstrap.js

yarn build

Compile

mix compile

Test

mix test
yarn test

Build

MIX_ENV=prod mix do clean, compile, 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

gitter room

#elixirscript on the elixir-lang Slack

Contributing

Please check the CONTRIBUTING.md

Packages

 
 
 

Contributors