{"id":13804093,"url":"https://github.com/FrameOS/frameos","last_synced_at":"2025-05-13T17:31:17.623Z","repository":{"id":188218722,"uuid":"669318006","full_name":"FrameOS/frameos","owner":"FrameOS","description":"Operating system for single function smart frames","archived":false,"fork":false,"pushed_at":"2025-04-29T23:51:24.000Z","size":21433,"stargazers_count":370,"open_issues_count":12,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-30T00:30:03.324Z","etag":null,"topics":["framebuffer","hdmi","inky","inkyimpression","pimoroni","raspberry-pi","waveshare","waveshare-epaper"],"latest_commit_sha":null,"homepage":"https://frameos.net/","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FrameOS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2023-07-21T22:58:16.000Z","updated_at":"2025-04-27T03:21:39.000Z","dependencies_parsed_at":"2023-09-22T05:09:38.501Z","dependency_job_id":"a188d19d-f654-4c06-8565-a3c106e20a22","html_url":"https://github.com/FrameOS/frameos","commit_stats":null,"previous_names":["mariusandra/frameos","frameos/frameos"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameOS%2Fframeos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameOS%2Fframeos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameOS%2Fframeos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrameOS%2Fframeos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FrameOS","download_url":"https://codeload.github.com/FrameOS/frameos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253993005,"owners_count":21996213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["framebuffer","hdmi","inky","inkyimpression","pimoroni","raspberry-pi","waveshare","waveshare-epaper"],"created_at":"2024-08-04T01:00:41.689Z","updated_at":"2025-05-13T17:31:15.372Z","avatar_url":"https://github.com/FrameOS.png","language":"C","readme":"# FrameOS\n\nFrameOS is an **operating system for single function smart frames**. \n\nIt's meant to be deployed on a Raspberry Pi, and can be used with a variety of e-ink and traditional displays. It's designed for both screens that update **60 seconds per frame**, and for screens that update **60 frames per second**.\n\nThink smart home calendars, meeting room displays, thermostats, industrial dashboards, public advertisement screens, and more.\n\nTo get started:\n\n1. Install the [FrameOS backend](https://frameos.net/guide/backend), a dockerized python app, which is used to deploy apps onto individual frames via SSH.\n\n2. Read the [device hardware guide](https://frameos.net/devices/) for your screen type. Typically you'll just need to connect the display to a Raspberry Pi, install the OS, and make sure it's reachable over the network. \n\n3. Once connected, deploy our prebuilt scenes, or code your own directly inside the backend.\n\n4. Finally, for a professional look, 3d print a case around your frame.\n\n![](https://frameos.net/assets/images/walkthrough-c32e7b67dd9a6f14ebef743755b0fc8e.gif)\n\n\n\n## Supported platforms\n\nSupported are all the most common e-ink displays out there.\n\n- Pimoroni e-ink frames\n- Waveshare e-ink\n- Framebuffer HDMI output\n- Web server kiosk mode\n\n[See the full list here!](https://frameos.net/devices/)\n\n## FrameOS backend\n\nThe FrameOS backend is where you set up your frames. You can run it continuously on a server, or locally on your computer when needed. You'll just miss out on log aggregation if the backend is offline. The frames run independently.\n\nRead more in [the documentation](https://frameos.net/guide/backend).\n\n### Quick install\n\nThe easiest way to install the FrameOS backend on a Mac or Debian/Ubuntu Linux is to run the following installation script:\n\n```bash\ncurl -fsSL https://frameos.net/install.sh | bash\n```\n\n### Running via Docker manually\n\n```bash\n# running the latest release\nSECRET_KEY=$(openssl rand -base64 32)\nmkdir db\ndocker run -d -p 8989:8989 -v ./db:/app/db --name frameos --restart always -e SECRET_KEY=\"$SECRET_KEY\" frameos/frameos\n\n# update daily to the latest release\ndocker run -d \\\n    --name watchtower \\\n    -v /var/run/docker.sock:/var/run/docker.sock \\\n    containrrr/watchtower \\\n    --interval 86400 \\\n    frameos\n\n# one time update\ndocker run \\\n    -v /var/run/docker.sock:/var/run/docker.sock \\\n    containrrr/watchtower \\\n    --run-once \\\n    frameos\n\n# running a local dev build via docker\nSECRET_KEY=$(openssl rand -base64 32)\ndocker build -t frameos .\ndocker run -d -p 8989:8989 -v ./db:/app/db --name frameos --restart always -e SECRET_KEY=\"$SECRET_KEY\" frameos\n```\n","funding_links":[],"categories":["Nim"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFrameOS%2Fframeos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFrameOS%2Fframeos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFrameOS%2Fframeos/lists"}