{"id":25637454,"url":"https://github.com/coderwelsch/smart-home-screen","last_synced_at":"2026-05-01T12:32:42.872Z","repository":{"id":219644683,"uuid":"749529352","full_name":"Coderwelsch/smart-home-screen","owner":"Coderwelsch","description":"Web Interface for small devices (eg. Raspberry Pis) to display Calendar Events, Todoist tasks and more","archived":false,"fork":false,"pushed_at":"2025-07-10T13:11:36.000Z","size":2346,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-15T02:44:55.984Z","etag":null,"topics":["frontend","ical","icloud","raspberry-pi","react","smarthome","todoist","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Coderwelsch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-28T20:43:50.000Z","updated_at":"2025-07-10T13:11:41.000Z","dependencies_parsed_at":"2025-05-26T13:24:08.608Z","dependency_job_id":"fd978333-32cc-4883-a177-9ca1cb7596a3","html_url":"https://github.com/Coderwelsch/smart-home-screen","commit_stats":null,"previous_names":["coderwelsch/smart-home-screen"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Coderwelsch/smart-home-screen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderwelsch%2Fsmart-home-screen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderwelsch%2Fsmart-home-screen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderwelsch%2Fsmart-home-screen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderwelsch%2Fsmart-home-screen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Coderwelsch","download_url":"https://codeload.github.com/Coderwelsch/smart-home-screen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderwelsch%2Fsmart-home-screen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32497812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["frontend","ical","icloud","raspberry-pi","react","smarthome","todoist","typescript"],"created_at":"2025-02-23T01:27:26.685Z","updated_at":"2026-05-01T12:32:42.853Z","avatar_url":"https://github.com/Coderwelsch.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Smart Home Display (Frontend)\n\n![teaser.gif](docs/teaser.png)\n\n\u003e Customizable static web app that can be run on a Raspberry Pi or any other device to show useful data like calendar or todoist infos.\n\n\n## Features\n\nThis project includes the following modules which you can enable or disable by setting up the corresponding .env variables:\n\n- Home Screen\n  - does nothing currently except showing the welcome message\n- Todoist Overview\n  - shows all uncompleted tasks and sub tasks\n- Calendar (ICS) Overview\n  - shows events of the next 7 days\n- Left Navigation Bar will hide automatically when only one «module» is present\n\nCurrently the app automatically rotates through the modules every ~ 30 seconds and scrolls through the content if it is too long to fit on the screen.\n\n\u003e ⚠️ More modules will be added in the future. Feel free to contribute!\n\n## Installation\n\n1. Clone the repository\n2. Run `yarn` to install the dependencies\n3. Create a `.env` file in the root directory by copying the `.env.example` file\n\n\n## Configuration\n\nThe `.env` file contains the following variables:\n\n### `REACT_APP_API_PORT`\n\nSet this variable to the port of the backend server. The backend server is used to fetch the data from the external APIs (e.g. ics calendar data).\n\n### `REACT_APP_TODOIST_API_KEY`\n\nSet this variable to your Todoist API key to enable todoist integration. If not set, the todoist module will be disabled.\n\n### `REACT_APP_CALENDAR_WEBCAL_URLS`\n\nSet this variable to a define one or multiple webcal URLs to enable the calendar integration. \n\n### `REACT_APP_CALENDAR_WEBCAL_NAMES`\n\nSet this variable to define the names of the calendars. The names should be separated by a comma and the order should match the order of the URLs in `REACT_APP_CALENDAR_WEBCAL_URLS`.\n\n### `REACT_APP_CALENDAR_WEBCAL_COLORS`\n\nSupported colors:\n\n`red`,`orange`,`amber`,`yellow`,`lime`,`green`,`emerald`,`teal`,`cyan`,`sky`,`blue`,`indigo`,`violet`,`purple`,`fuchsia`,`pink`,`rose`,`slate`,`gray`,`zinc`,`neutral`, `stone`\n\nSet this variable to define the colors of the calendars. The colors should be separated by a comma and the order should match the order of the URLs in `REACT_APP_CALENDAR_WEBCAL_URLS`.\n\n## Build\n\nRun `yarn build` to build the project. The build artifacts will be stored in the `build/` directory.\n\n\n## Run\n\nRun `yarn serve` to start the proxy server and serve the static files (e.g. on your raspberry pi). The app will be available at `http://localhost:3000`.\n\nOn crash the app will automatically restart by the help of `nodemon`.\n\n## Autostart / Systemd Service\n\nTo run the built app on a Raspberry Pi or any other device you can setup a systemd service. You can use the example service files from the `systemd-service` directory.\n\nPlease note that the `.sh` scripts under `./systemd-service` directory have absolute urls pointing to `/home/pi/smart-home-screen`, so you need to adjust them according to your setup and directory.\n\n1. Copy the `kiosk.service` file to `/etc/systemd/system/`\n2. Make sure to setup the systemd paths correctly in the `kiosk.service` file\n3. Run `sudo systemctl enable kiosk.service` to enable the service\n4. Run `sudo systemctl start kiosk.service` to start the service\n5. Run `sudo systemctl status kiosk.service` to check the status of the service\n6. To stop the service run `sudo systemctl stop kiosk.service`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderwelsch%2Fsmart-home-screen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderwelsch%2Fsmart-home-screen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderwelsch%2Fsmart-home-screen/lists"}