Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shuhei/elmbda

My tiny attempt to implement lambda calculus with Elm
https://github.com/shuhei/elmbda

elm lambda-calculus

Last synced: 18 days ago
JSON representation

My tiny attempt to implement lambda calculus with Elm

Awesome Lists containing this project

README 

        
# elmbda (work in progress)



My tiny attempt to implement lambda calculus with Elm. It will progress as I read [An Introduction to Functional Programming Through Lambda Calculus](http://store.doverpublications.com/0486478831.html).



--



This project is bootstrapped with [Create Elm App](https://github.com/halfzebra/create-elm-app).



Below you will find some information on how to perform basic tasks.  

You can find the most recent version of this guide [here](https://github.com/halfzebra/create-elm-app/blob/master/template/README.md).



## Table of Contents

- [Sending feedback](#sending-feedback)

- [Folder structure](#folder-structure)

- [Installing Elm packages](#installing-elm-packages)

- [Installing JavaScript packages](#installing-js-packages)

- [Available scripts](#available-scripts)

  - [elm-app build](#elm-app-build)

  - [elm-app start](#elm-app-start)

  - [elm-app test](#elm-app-test)

  - [elm-app eject](#elm-app-eject)

  - [elm-app ](#elm-app-elm-platform-comand)

    - [package](#package)

    - [repl](#repl)

    - [make](#make)

    - [reactor](#reactor)

- [Adding Images and Fonts](#adding-images-and-fonts)

- [IDE setup for Hot Module Replacement](#ide-setup-for-hot-module-replacement)

- [Deploying to GitHub Pages](#deploying-to-github-pages)



## Sending feedback

You are very welcome with any [feedback](https://github.com/halfzebra/create-elm-app/issues)



## Installing Elm packages



```sh

elm-app package install 

```



## Installing JavaScript packages



To use JavaScript packages from npm, you'll need to add a `package.json`, install the dependencies, and you're ready to go.



```sh

npm init -y # Add package.json

npm install --save-dev pouchdb-browser # Install library from npm

```



```js

// Use in your JS code

var PouchDB = require('pouchdb-browser');

var db = new PouchDB('mydb');

```



## Folder structure

```

my-app/

  .gitignore

  README.md

  elm-package.json

  src/

    App.elm

    favicon.ico

    index.html

    index.js

    main.css

  tests/

    elm-package.json

    Main.elm

    Tests.elm

```

For the project to build, these files must exist with exact filenames:



- `src/index.html` is the page template;

- `src/favicon.ico` is the icon you see in the browser tab;

- `src/index.js` is the JavaScript entry point.



You can delete or rename the other files.



You may create subdirectories inside src.



## Available scripts

In the project directory you can run:

### `elm-app build`

Builds the app for production to the `dist` folder.  



The build is minified, and the filenames include the hashes.  

Your app is ready to be deployed!



### `elm-app start`

Runs the app in the development mode.  

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.



The page will reload if you make edits.  

You will also see any lint errors in the console.



### `elm-app test`

Run tests with [node-test-runner](https://github.com/rtfeldman/node-test-runner/tree/master)



You can make test runner watch project files by running:

```sh

elm-app test --watch

```



### `elm-app eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**



If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time.



Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Elm Platform, etc.) right into your project, so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point, you’re on your own.



You don’t have to use 'eject' The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However, we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.



### `elm-app `

Create Elm App does not rely on the global installation of Elm Platform, but you still can use it's local Elm Platform to access default command line tools:



#### `package`

Alias for [elm-package](http://guide.elm-lang.org/get_started.html#elm-package)



Use it for installing Elm packages from [package.elm-lang.org](http://package.elm-lang.org/)



#### `repl`

Alias for [elm-repl](http://guide.elm-lang.org/get_started.html#elm-repl)



#### `make`

Alias for  [elm-make](http://guide.elm-lang.org/get_started.html#elm-make)



#### `reactor`

Alias for  [elm-reactor](http://guide.elm-lang.org/get_started.html#elm-reactor)



## Adding Images and Fonts



With Webpack, using static assets like images and fonts works similarly to CSS.



By requiring an image in JavaScript code, you tell Webpack to add a file to the build of your application. The variable will contain a unique path to the said file.



Here is an example:



```js

require('./main.css');

var logoPath = require('./logo.svg'); // Tell Webpack this JS file uses this image

var Elm = require('./App.elm');



var root = document.getElementById('root');



Elm.App.embed(root, logoPath); // Pass image path as a flag.

```

Later on, you can use the image path in your view for displaying it in the DOM.



```elm

view : Model -> Html Msg

view model =

    div []

        [ img [ src model.logo ] []

        , div [] [ text model.message ]

        ]

```



## IDE setup for Hot Module Replacement

Remember to disable [safe write](https://webpack.github.io/docs/webpack-dev-server.html#working-with-editors-ides-supporting-safe-write) if you are using VIM or IntelliJ IDE, such as WebStorm.



## Deploying to GitHub Pages



#### Step 1: install [gh-pages](https://github.com/tschaub/gh-pages)

```sh

npm install gh-pages -g

```



#### Step 2: configure `SERVED_PATH` environment variable

Create a `.env` file in the root of your project to specify the `SERVED_PATH` environment variable.



```

SERVED_PATH=./

```



The path must be `./` so the assets are served using relative paths.



#### Step 3: build the project and deploy it to GitHub Pages

```sh

elm-app build

gh-pages -d dist

```