mirror of
https://github.com/home-assistant/frontend.git
synced 2025-04-23 12:57:21 +00:00
d32d334a2e
* Review Docker management ( linked with #934 ) * fix comment by @balloob * Explicit remove of package-lock.json * moved on feature branch, merge docker scripts, added documetation * Used alphine as requested by @balloob on https://github.com/home-assistant/home-assistant-polymer/pull/947 and followed the @mcspr comment https://github.com/home-assistant/home-assistant-polymer/issues/934 * Remove package-lock from gitignore, we don't use npm * Update for new build instructions
34 lines
2.1 KiB
Markdown
34 lines
2.1 KiB
Markdown
# Home Assistant Polymer [](https://travis-ci.org/home-assistant/home-assistant-polymer)
|
|
|
|
This is the repository for the official [Home Assistant](https://home-assistant.io) frontend.
|
|
|
|
[](https://home-assistant.io/demo/)
|
|
|
|
- [View demo of the Polymer frontend](https://home-assistant.io/demo/)
|
|
- [More information about Home Assistant](https://home-assistant.io)
|
|
- [Frontend development instructions](https://developers.home-assistant.io/docs/en/frontend_index.html)
|
|
|
|
## Development
|
|
|
|
- Initial setup: `script/setup`
|
|
- Development: [Instructions](https://developers.home-assistant.io/docs/en/frontend_development.html)
|
|
- Production build: `script/build_frontend`
|
|
- Gallery: `cd gallery && script/develop_gallery`
|
|
- Hass.io: [Instructions](https://developers.home-assistant.io/docs/en/hassio_hass.html)
|
|
|
|
## Frontend development
|
|
|
|
### Classic environment
|
|
A complete guide can be found at the following [link](https://www.home-assistant.io/developers/frontend/). It describes a short guide for the build of project.
|
|
|
|
### Docker environment
|
|
It is possible to compile the project and/or run commands in the development environment having only the [Docker](https://www.docker.com) pre-installed in the system. On the root of project you can do:
|
|
* `sh ./script/docker_run.sh build` Build all the project with one command
|
|
* `sh ./script/docker_run.sh bash` Open an interactive shell (the same environment generated by the *classic environment*) where you can run commands. This bash work on your project directory and any change on your file is automatically present within your build bash.
|
|
|
|
**Note**: if you have installed `npm` in addition to the `docker`, you can use the commands `npm run docker_build` and `npm run bash` to get a full build or bash as explained above
|
|
|
|
## License
|
|
|
|
Home Assistant is open-source and Apache 2 licensed. Feel free to browse the repository, learn and reuse parts in your own projects.
|