Skip to content

Normation/rudder-elm-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rudder Elm library

Our Elm "library" for sharing code :

  • between Rudder and plugins
  • factorized data types and logics, split into modules (to a certain extent, some are "components" which require Nested TEA)

Installation

This git repo is installed using elm-git-install :

  • to have our own versioning semantic, and not the one enforced by Elm ("Semantic versioning")
  • to be able to facilitate development on the library by changing git branch

To install :

  • add a elm-git.json file next to the elm.json file, with the desired version of this library :

    {
      "git-dependencies": {
        "direct": {
          "https://github.com/Normation/rudder-elm-library.git": "x.x.x"
        },
        "indirect": {}
      }
    }
  • add the elm-github-install npm package to your npm project

  • add an npm script to run elm-git-install :

    {
      "scripts": {
        "elm-git-install": "cd elm && elm-git-install"
      },
      ...
    }
  • add npm run elm-git-install to your build script

Caveats

  • Elm dependency management is not automatic when installing this library, it will require dependencies of modules that are imported to be installed

About

Shared components for Rudder Elm pages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages