remyyounes / elm-flock

Simple Flock ( or Swarm ) elm visualization

This project was bootstrapped with Create Elm App.

Below you will find some information on how to perform common tasks.
You can find the most recent version of this guide here.

Table of Contents

• Sending feedback
• Folder structure
• Installing Elm packages
• Installing JavaScript packages
• Available scripts
  • elm-app build
  • elm-app start
  • elm-app test
  • elm-app eject
  • elm-app
    • package
    • repl
    • make
    • reactor
• IDE setup for Hot Module Replacement

Sending feedback

You are very velcome with any feedback

Installing Elm packages

elm-app package install <package-name>

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.

npm init -y # Add package.json
npm install --save-dev pouchdb-browser # Install library from npm

// 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/
    favicon.ico
    index.html
    index.js
    main.css
    Main.elm
  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 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

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 ever 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 <elm-platform-comand>

Create Elm App does not rely on 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

Use it for installing Elm packages from package.elm-lang.org

repl

Alias for elm-repl

make

Alias for elm-make

reactor

Alias for elm-reactor

IDE setup for Hot Module Replacement

Remember to disable safe write if you are using VIM or IntelliJ IDE, such as WebStrom.