legendairie / elm_spa_example Goto Github PK

This project is bootstrapped with 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.

• 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
• Adding Images and Fonts
• IDE setup for Hot Module Replacement
• Deploying to GitHub Pages

You are very welcome with any feedback

elm-app package install <package-name>

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');

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.

In the project directory you can run:

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!

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.

Run tests with node-test-runner

You can make test runner watch project files by running:

elm-app test --watch

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.

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:

Alias for elm-package

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

Alias for elm-repl

Alias for elm-make

Alias for elm-reactor

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:

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.

view : Model -> Html Msg
view model =
    div []
        [ img [ src model.logo ] []
        , div [] [ text model.message ]
        ]

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

npm install gh-pages -g

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.

elm-app build
gh-pages -d dist