https://github.com/cghome/create-homey-app
Create Homey-App without build configuration
https://github.com/cghome/create-homey-app
create-homey-app docker homey npx remote-development-container vscode
Last synced: about 1 month ago
JSON representation
Create Homey-App without build configuration
- Host: GitHub
- URL: https://github.com/cghome/create-homey-app
- Owner: cgHome
- Created: 2021-02-04T15:40:57.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-23T12:34:38.000Z (over 5 years ago)
- Last Synced: 2025-03-01T09:14:57.893Z (over 1 year ago)
- Topics: create-homey-app, docker, homey, npx, remote-development-container, vscode
- Language: Shell
- Homepage:
- Size: 109 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Create Homey App
`This app is still under development`
Create Homey-App without build configuration. In a single command, this tool bootstraps an app with associated version management and a dockerized remote development environments.
"Old" apps can also be upgraded, if the command is called in the existing app-root directory.
- [Creating an App](https://github.com/cgHome/create-homey-app#creating-or-update-an-homey-app)
- [Homey Apps SDK v3](https://apps-sdk-v3.developer.athom.com/)
Create Homey App works on macOS, Windows, and Linux.\
If something doesn’t work, please file an [issue](https://github.com/cgHome/create-homey-app/issues).\
If you have questions or need help, please ask in [Homey Community Forum](https://community.athom.com/t/create-homey-app-create-homey-app-without-build-configuration/43060).
----
## Requirements
- [Visual Studio Code](https://code.visualstudio.com/)
- [VSCode Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
- [Docker](https://www.docker.com/)
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en/)
----
## Quick Overview
```sh
npx create-homey-app [my-app]
cd my-app
code .
```
If you've previously installed [Homey Command-line interface](https://www.npmjs.com/package/homey) globally via `npm i -g homey`, we recommend you uninstall the package using `npm uninstall -g homey` or `yarn global remove homey` to ensure that npx always uses the latest version.
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
----
## Note
**This is my second attempt to normalize and simplify the structure of my homey app development environment with VSCode.**
----
## Creating or update an Homey-App
### npx
```sh
# Invoking from the npm registery
npx create-homey-app [my-app]
# Invoking from the github repository
npx github:cghome/create-homey-app [my-app]
```
### npm
```sh
npm init homey-app [my-app]
```
_`npm init ` is available in npm 6+_
### Yarn
```sh
yarn create homey-app [my-app]
```
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
----
## Add on's
### Homey debugger
Add to app.js
```js
/**
* homey-debugger
*/
/* eslint-disable */
if (process.env.DEBUG === "1") {
require("inspector").open(9229, "0.0.0.0", false);
// require("inspector").open(9229, "0.0.0.0", true);
}
/* eslint-enable */
```
----
## What's included
### npm-scripts
- test - homey app run
- start - npm install && homey app install
- build - homey app build
- publish - homey app publish
- postpublish - npm run init && git commit --amend --no-edit ./package.json && git push -f origin main
- validate - homey app validate -l publish
- validateTest - homey app validate
- init - npm init --quiet -y 1>/dev/null
- eslint - eslint
- prettier - prettier
- createRemoteRepo (only if remote-repository not exists) - hub create -d "$npm_package_description" -h $npm_package_homepage ${PWD##*/} && git commit --amend --no-edit && git push -u origin main && npm run init
----
## For Developers
```sh
# Install Create-Homey-App
git clone https://github.com/cgHome/create-homey-app.git
cd create-homey-app
code .
# Happy coding
# Test app > use JavaScript Debug Terminal
npm run start -- [my-app] -OR-
npm run create-homey-app -- [my-app]
# Publish package
npm version [patch|minor|major]
npm publish
```
### Tutorials
- [Developing inside a Container](https://code.visualstudio.com/docs/remote/containers)
- [Dockerisieren Sie Ihre Entwicklungsumgebung in VS Code](https://ichi.pro/de/post/234589651404201)
### Development Container Tips & Tricks
- [VS Code - Remote Development](https://github.com/microsoft/vscode-dev-containers/tree/master)
- [VS Code - Contributing](https://github.com/microsoft/vscode-dev-containers/blob/master/CONTRIBUTING.md)
- [VS Code - Scripts:](https://github.com/microsoft/vscode-dev-containers/tree/master/script-library)
### Create apps
- see:
- see:
- see:
----
## Changelog
v0.1.0
- Initial commit
----
## ToDo
- Add Screencast
- Add localHomey - Parameter
----
## Copyright
Copyright 2021, 2021 [Chris Gross] cFlat-inc.org