home-assistant.io/source/developers/index.markdown

layout, title, description, date, sidebar, comments, sharing, footer

layout	title	description	date	sidebar	comments	sharing	footer
page	Developers	Home Assistant developer information. Everything to get you started	2014-12-21 13:32	false	false	true	true

Home Assistant is build from the ground-up to be easily extensible by other developers using components. It uses Python 3 for the backend and Polymer (Webcomponents) for the frontend.

Home Assistant is open-source and MIT licensed. The source can be found here:

• home-assistant - Python server-backend
• home-assistant-js - javascript-backend powering the client
• home-assistant-polymer - Polymer UI

{% linkable_title Starting development %}

You will need to setup a development environment if you want to start developing a new feature or component for Home Assistant perform theses steps

git clone https://github.com/balloob/home-assistant.git
cd home-assistant
script/setup

After following these steps, running hass will invoke your local installation.

{% linkable_title Submitting improvements %}

Improvements to Home Assistant should be submitted one feature at a time using Github pull requests.

1. Go to the Home Assistant repository and click fork in the top right.
2. Follow steps in the previous section but with your forked repository.
3. Create a new branch to hold your changes
   git checkout -b some-feature
4. Make the changes you want
5. Commit the changes
   git add .
git commit -m "Added some-feature"
6. Push your commited changes back to your fork on Github
   git push origin HEAD
7. Follow these steps to create your pull request.

{% linkable_title Further reading %}

• Home Assistant Architecture
• Frontend development
• Creating a custom component
• Adding support for a new platform
• Rest API
• Website