diff --git a/README.md b/README.md index b89b348b..52907b9d 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,10 @@ Clone this repository ### Step 2 -Install necessary modules +Install necessary modules (verified to work in node 8.x) `yarn install` or `npm install` + ### Step 3 Do a test lint & build on the project. You can see available scripts in the package.json @@ -70,11 +71,15 @@ Customize to suit your needs and contribute it back to the community ## Starting a new card from boilerplate-card with [devcontainer][devcontainer] +Note: this is available only in vscode ensure you have the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed. + 1. Fork and clone the repository. -2. Open the [devcontainer][devcontainer] and run `npm start` when it's ready. -3. The compiled `.js` file will be accessible on +2. Install necessary modules (verified to work in node 8.x) +`yarn install` or `npm install` +3. Open a [devcontainer][devcontainer] terminal and run `npm start` when it's ready. +4. The compiled `.js` file will be accessible on `http://127.0.0.1:5000/boilerplate-card.js`. -4. On a running Home Assistant installation add this to your Lovelace +5. On a running Home Assistant installation add this to your Lovelace `resources:` ```yaml @@ -92,6 +97,16 @@ If you need a fresh test instance you can install a fresh Home Assistant instanc 2. Home Assistant will install and will eventually be running on port `9123` ## [Troubleshooting](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins) +NB This will not work with node 9.x if you see the following errors try installing node 8.10.0 +```yarn install +yarn install v1.3.2 +[1/4] 🔍 Resolving packages... +warning rollup-plugin-commonjs@10.1.0: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-commonjs. +[2/4] 🚚 Fetching packages... +error @typescript-eslint/eslint-plugin@2.6.0: The engine "node" is incompatible with this module. Expected version "^8.10.0 || ^10.13.0 || >=11.10.1". +error Found incompatible module +info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command. +``` [commits-shield]: https://img.shields.io/github/commit-activity/y/custom-cards/boilerplate-card.svg?style=for-the-badge [commits]: https://github.com/custom-cards/boilerplate-card/commits/master