Pull requests are welcome from everyone.
This project is written in TypeScript and uses Nest.js for the server and Angular for the client UI.
Note: The Raspberry Pi and similar boards do not meet the memory or CPU requirements required to set up the development environment.
First, remove any globally installed versions of homebridge-config-ui-x you may have installed on your development machine:
npm uninstall -g homebridge-config-ui-xFork, then clone the repo:
git clone [email protected]:your-username/homebridge-config-ui-x.gitInstall npm dependencies for the plugin and the UI:
npm install && cd ui && npm install && cd ..Build the plugin, it may take sometime to compile the UI:
npm run buildSymlink your development directory to global:
npm linkIf you don't have homebridge installed already run:
npm install -g homebridgeThis will start the Angular development server on port 4200 and a standalone server on port 8581. It will also watch and compile changes made to the server side TypeScript code:
npm run watchYou should now be able to navigate to https://localhost:4200 in your browser which will connect to your homebridge instance running on port 8581. The UI will automatically reload whenever you make changes to the code.
If you have made changes to the server side code, you should run the e2e test suite before creating a pull request:
npm run testAdditional language translations, or improvements to existing translations are most welcome. Translations can be found here:
https://github.com/homebridge/homebridge-config-ui-x/tree/latest/ui/src/i18n