πŸƒ Create Elm apps with zero configuration
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Remove trailing spaces Feb 1, 2018
bin chore: Use empty console.log calls instead of newline character Oct 11, 2018
config fix: Fix setupProxy configuration option Dec 14, 2018
scripts fix: Fix a typo in a warning and add a warning for DEAD_CODE_ELIMINAT… Nov 5, 2018
template add example: When Configuring to a different port Jan 22, 2019
tests Uglifyjs settings for elm 0.19 Nov 3, 2018
.editorconfig Update for Elm 0.19 Aug 26, 2018
.eslintignore chore: Rework ESLint config, format .prettierrc, add vendor stuff to … Sep 28, 2018
.eslintrc chore: Rework ESLint config, format .prettierrc, add vendor stuff to … Sep 28, 2018
.gitignore chore: exclude testing assets from vcs Feb 7, 2019
.npmrc chore(.npmrc): Disable package-lock.json to enable automatic upgrades… Sep 28, 2018
.prettierrc chore: Rework ESLint config, format .prettierrc, add vendor stuff to … Sep 28, 2018
.travis.yml ci: removed the config for yarn cache Feb 7, 2019
CHANGELOG.md Remove trailing spaces Feb 1, 2018
CONTRIBUTING.md chore(CONTRIBUTING.md): remove mentions of yarn from the docs. Dec 11, 2018
LICENSE Create LICENSE Nov 26, 2018
README.md docs: Include parcel into the lsit of alternatives Dec 12, 2018
appveyor.yml ci: remove -g flag from appveyor linking setup Feb 7, 2019
commitlint.config.js ci: added the setup for commit validation Feb 7, 2019
package.json ci: added the configuration for debugging appveyor test failure Feb 7, 2019

README.md

Create Elm App npm version Build Status Build Status

Create Elm apps with no build configuration.

Quickstart

npm install create-elm-app -g
create-elm-app my-app
cd my-app/
elm-app start

Create a production build with elm-app build

Getting Started

Installation

Node >=8 is required for installation.

Yarn

yarn global add create-elm-app

NPM

npm install create-elm-app -g

If you are running Linux OS, you should install it as the superuser:

sudo npm install create-elm-app -g

Creating an App

To create a new app, run:

create-elm-app my-app
cd my-app/

create-elm-app

Create a new my-app folder with files for your future project.

my-app/
β”œβ”€β”€ .gitignore
β”œβ”€β”€ README.md
β”œβ”€β”€ elm.json
β”œβ”€β”€ elm-stuff
β”œβ”€β”€ public
β”‚   β”œβ”€β”€ favicon.ico
β”‚   β”œβ”€β”€ index.html
β”‚   β”œβ”€β”€ logo.svg
β”‚   └── manifest.json
β”œβ”€β”€ src
β”‚   β”œβ”€β”€ Main.elm
β”‚   β”œβ”€β”€ index.js
β”‚   β”œβ”€β”€ main.css
β”‚   └── registerServiceWorker.js
└── tests
    └── Tests.elm

You are ready to employ the full power of Create Elm App!

elm-app start

Run the app in development mode. Open http://localhost:3000 to view it in the browser.

elm-app-start

The page will reload if you make edits. You will see the build errors and lint warnings in the console and the browser window.

elm-app build

Builds the app for production to the build folder. It bundles Elm app and optimizes the build for the best performance.

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

Guide

Every generated project will contain a readme with guidelines for future development. The latest version is available here

Why use this?

Developing with Elm is fun and easy, but at some point, you will hit a couple of limitations.

Create Elm App adds a tool for optimizing production builds and running a development server with your app, which supports HMR.

All of that, combined with all the functionality of elm in a single command line tool, which you might use as a dependency or eject anytime.

Want a custom setup?

Not happy with the default configuration? Use elm-app eject and customize your process.

That way, you can use Create Elm App as a tool for a boilerplate generation.

Philosophy

Inspired by create-react-app

  • One Dependency: There is just one build dependency. It uses Elm Platform, Webpack, and other amazing projects, but provides a cohesive curated experience on top of them.

  • Zero Configuration: No configuration files or command line options required to start working with Elm. Configuring both development and production builds is handled for you so you can focus on writing code.

  • No Lock-In: You can β€œeject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.

What is inside

The tools used by Create Elm App are subject to change. Currently it is a thin layer on top of many amazing community projects, such as:

All of them are transitive dependencies of the provided npm package.

Contributing

We would love to get you involved! Please check our Contributing Guide to get started!

Alternatives