README.md

Overview of coral.js-tutorials

This repo contains demos for Coral.js, an extensible, functional-reactive framework.

Coral.js is an open source project of LockerDome.

Visit our live demo app here.

Table of Contents

• List of Demos
• How To Use This Repo
• Contributing
• License

List of Demos

• hello_world gets you started with a barebones Coral.js app (code).
• demos is full of examples showcasing different features of Coral.js (code | live).

How To Use This Repo

Steps

1. Setup and Installation
2. Build an app
3. View an app

1. Setup and Installation

Prerequisites and Compatibility:

• The Coral.js compiler supports versions of Node.js 0.8 and above.

2. Build an app

1. Inside coral.js-tutorials, navigate to the demo directory of your choice. The example below uses hello_world:

$ cd hello_world

$ npm install

2. Then, run either of the following commands in your terminal to build your Hello, world! app:

$ ./build.sh (this runs the same code as below)

- OR -

$ node node_modules/@lockerdome/coral.js/cli/cli.js --s compiler_settings.js

3. View an app

E.g. with hello_world, visit

/../your/path_to/coral.js-tutorials/hello_world/static/index.html

E.g. with demos, visit:

/../your/path_to/coral.js-tutorials/demos/static/index.html

Contributing

Coral.js is an open source project and we gladly welcome contributions.

Before submitting a pull request, you'll need to make sure you sign the CLA.

Please read our guide on contributing for additional information.

License

Coral.js is MIT licensed.