npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

generator-liferay-elm

v1.2.0

Published

Yeoman generator for creating Liferay projects with Elm.

Downloads

294

Readme

Liferay Elm Generator npm version Build Status Renovate enabled

A Yeoman generator for creating Liferay Elm projects, using the amazing Create Elm App for a fast and easy development with no build configuration. To create a build for Liferay, it uses the liferay-npm-bundler from the very useful Liferay JS Toolkit.

Installation

Node >=10 is required for installation.

First, install Yeoman and generator-liferay-elm using npm (assuming you have pre-installed node.js).

npm install -g yo generator-liferay-elm

Then generate your new project:

yo liferay-elm

You can also try it locally by cloning the repo and running npm link inside the project.

Getting started

Once the project generated:

cd my-elm-project
yarn start

Where my-elm-project is the default name provided by the generator. Change it accordingly to the name you choose.

If you choose the pre-configured Liferay Docker environment, you might want to start it with:

docker-compose up -d

Build your app for Liferay:

yarn build:liferay

Deploy your app to Liferay:

yarn deploy:liferay

Run tests:

yarn test
# or in watch mode
yarn test --watch

The first time, you might see this message: INFO: Running elmi-to-json for the first time; downloading the actual binary. Simply run the command again.

Install a new package (e.g. elm/svg):

yarn run elm-install elm/svg

This generator gives you scripts that are aliases to the one provided by Create Elm App (e.g. yarn start for elm-app start). To learn more about the tasks available for your project, directly checkout this guide.

Trying it locally

If you to try this generator on your local machine, feel free to clone this repo and run the following commands:

# install dependencies:
yarn
# make it available for yeoman:
npm link

Examples

If you want to see and try some examples, checkout this dedicated repository: https://github.com/lgdd/liferay-elm-examples.

What is Elm?

As the official site states, Elm is a delightful language for reliable webapps. How? By providing features such as:

  • No Runtime Exceptions
  • Great Performance
  • Enforced Semantic Versioning
  • Small Assets
  • JavaScript Interop

The best way to learn Elm is to follow the official guide. You can try Elm with this online editor.

You can also checkout this non-exhaustive list of nice talks about Elm:

License

LGPL-3.0