Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 1.1 KB

Contributing

Pull requests are welcome from everyone.

This project is written in TypeScript and Angular for the server portal UI.

Getting Setup

First, remove any globally installed versions of homebridge-gsh you may have installed on your development machine:

npm uninstall -g homebridge-gsh

Fork, then clone the repo:

git clone [email protected]:your-username/homebridge-gsh.git

Install npm dependencies for the plugin:

npm install

Build the plugin:

npm run build:plugin

Symlink your development directory to global:

npm link

You can now run homebridge and it will use homebridge-gsh from your development directory.

Contributing To Cloud Components

This plugin also depends on some cloud components, such as the account linking and message routing services.

Install the npm dependencies for the server and portal:

npm run install:server
npm run install:portal

Build the services, it may take sometime to compile the UI:

npm run build

Start the server:

npm run start:server