Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tiagogm/aurelia-elm
Aurelia plugin to embed Elm apps inside aurelia
https://github.com/tiagogm/aurelia-elm
aurelia-elm aurelia-plugins elm elm-lang
Last synced: about 1 month ago
JSON representation
Aurelia plugin to embed Elm apps inside aurelia
- Host: GitHub
- URL: https://github.com/tiagogm/aurelia-elm
- Owner: tiagogm
- Created: 2017-05-06T11:47:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-05-06T12:31:06.000Z (over 7 years ago)
- Last Synced: 2024-11-13T16:14:50.329Z (about 1 month ago)
- Topics: aurelia-elm, aurelia-plugins, elm, elm-lang
- Language: JavaScript
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Aurelia elm
### A plugin to embed elm apps inside aurelia
This plugins's insipiration was the taken from [react-elm-components](https://github.com/evancz/react-elm-components) and [ng-elm](https://github.com/camargo/ng-elm) elm counterparts
### Install
`npm install aurelia-elm --save`
### Use
```javascript
export async function configure(aurelia) {
//...
aurelia.use
//..
.plugin('aurelia-elm')
}
```
##
```html
```
```javascript
//in your view-model
import { HelloWorld } from './elm-app.js';
export class MyViewModel {
constructor() {
this.elmApp = HelloWorld;
}
}
```
## Bindable props
- ```src``` - The compiled elm module that you imported.
- ```flags``` - If your elm app has flags pass them here
- ```ports``` - callback function called to handle the app's ports
## More about interop elm
Read this https://guide.elm-lang.org/interop/javascript.html
## Building The Code
To build the code, follow these steps.
1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:
```shell
npm install
```
3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:
```shell
npm install -g gulp
```
4. To build the code, you can now run:
```shell
gulp build
```
5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.
6. See `gulpfile.js` for other tasks related to generating the docs and linting.
## Running The Tests
To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:
1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:
```shell
npm install -g karma-cli
```
2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:
```shell
npm install -g jspm
```
3. Install the client-side dependencies with jspm:
```shell
jspm install
```
4. You can now run the tests with this command:
```shell
karma start
```