1.8 KiB
elm-pages
Static site generator for elm-markup.
Getting Started
Install Dependencies
npm install
Running Locally
npm start
Will compile your app and serve it from http://localhost:1234/ Changes to your source code will trigger a hot-reload in the browser, which will also show compiler errors on build failures.
Running Tests
npm test
or
npm run autotest
To re-run tests when files change.
Production build
npm run build
Will generate a production-ready build of your app in the dist folder.
Elm Commands
Elm binaries can be found in node_modules/.bin. They can be run from within
your project via npx
To install new Elm packages, run:
npx elm install <packageName>
Libraries & Tools
These are the main libraries and tools used to build elm-pages. If you're not sure how something works, getting more familiar with these might help.
Elm
Elm is a delightful language for creating reliable webapps. It guarantees no runtime exceptions, and provides excellent performance. If you're not familiar with it, the official guide is a great place to get started, and the folks on Slack and Discourse are friendly and helpful if you get stuck.
Elm Test
This is the standard testing library for Elm. In addition to being useful for traditional fixed-input unit tests, it also supports property-based testing where random data is used to validate behavior over a large input space. It's really useful!
Parcel
Parcel build and bundles the application's assets into individual HTML, CSS, and JavaScript files. It also runs the live-server used during development.