{"id":23262918,"url":"https://github.com/beaconcms/beacon","last_synced_at":"2025-05-14T00:09:23.377Z","repository":{"id":38066394,"uuid":"440585484","full_name":"BeaconCMS/beacon","owner":"BeaconCMS","description":"Open-source Content Management System (CMS) built with Phoenix LiveView. Faster render times to boost SEO performance, even for the most content-heavy pages.","archived":false,"fork":false,"pushed_at":"2025-04-09T13:00:35.000Z","size":9297,"stargazers_count":1134,"open_issues_count":57,"forks_count":111,"subscribers_count":31,"default_branch":"main","last_synced_at":"2025-04-11T22:18:54.857Z","etag":null,"topics":["cms","elixir","elixir-lang","phoenix","phoenix-framework","phoenix-liveview"],"latest_commit_sha":null,"homepage":"https://beaconcms.org","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BeaconCMS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-12-21T16:41:12.000Z","updated_at":"2025-04-09T19:47:22.000Z","dependencies_parsed_at":"2023-10-02T19:49:18.549Z","dependency_job_id":"c5757ffb-967f-4f03-8672-bfabf8bb6d6c","html_url":"https://github.com/BeaconCMS/beacon","commit_stats":{"total_commits":765,"total_committers":40,"mean_commits":19.125,"dds":"0.27712418300653596","last_synced_commit":"8598a1dd3f4e55f31817f803432272392b511599"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeaconCMS%2Fbeacon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeaconCMS%2Fbeacon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeaconCMS%2Fbeacon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BeaconCMS%2Fbeacon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BeaconCMS","download_url":"https://codeload.github.com/BeaconCMS/beacon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254044140,"owners_count":22005085,"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":["cms","elixir","elixir-lang","phoenix","phoenix-framework","phoenix-liveview"],"created_at":"2024-12-19T14:13:07.341Z","updated_at":"2025-05-14T00:09:18.363Z","avatar_url":"https://github.com/BeaconCMS.png","language":"Elixir","readme":"# Beacon\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/BeaconCMS/beacon/main/assets/images/beacon.png\" width=\"256\" alt=\"Beacon logo\"\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \n  [![GitHub Release Version](https://img.shields.io/github/v/release/beaconCMS/beacon?color=blue)](https://hex.pm/packages/beacon)\n  [![GitHub Release Date](https://img.shields.io/github/release-date/beaconCMS/beacon)](https://github.com/BeaconCMS/beacon/releases)\n  [![GitHub License](https://img.shields.io/github/license/beaconCMS/beacon?color=orange)](https://github.com/BeaconCMS/beacon/blob/main/LICENSE.md)\n  [![Documentation](https://img.shields.io/badge/documentation-555555)](https://hexdocs.pm/beacon)\n  \n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  Beacon is a content management system (CMS) built with Phoenix LiveView. It brings the rendering speed benefits of Phoenix to even the most content-heavy pages with faster render times to boost SEO performance.\n\u003c/p\u003e\n\n## Getting Started\n\nInstall both Phoenix and Igniter installers:\n\n```sh\nmix archive.install hex phx_new \u0026\u0026 mix archive.install hex igniter_new\n```\n\nNow you can either create a new Phoenix project with Beacon or add Beacon to an existing Phoenix project:\n\n\u003cdetails\u003e\n\u003csummary\u003eCreate a new project\u003c/summary\u003e\n\n- Using latest published [beacon](https://hex.pm/packages/beacon) and [beacon_live_admin](https://hex.pm/packages/beacon_live_admin) packages:\n\n```sh\nmix igniter.new my_app --install beacon,beacon_live_admin --with phx.new --beacon.site my_site\n```\n\n- Or using the unreleased projects from GitHub from the main branch:\n\n```sh\nmix igniter.new my_app \\\n--install beacon@github:BeaconCMS/beacon,beacon_live_admin@github:BeaconCMS/beacon_live_admin \\\n--with phx.new \\\n--beacon.site my_site\n```\n\nReplace `my_app` and `my_site` with the names you want to generate and follow the prompts.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eAdd to existing project\u003c/summary\u003e\n\nIf you already have a Phoenix project with Phoenix LiveView then you can just add Beacon into that project.\n\nSimilar to starting a new project, you can install Beacon and BeaconLiveAdmin and generate a new site:\n\n- Using latest published [beacon](https://hex.pm/packages/beacon) and [beacon_live_admin](https://hex.pm/packages/beacon_live_admin) packages:\n\n```sh\nmix igniter.install beacon,beacon_live_admin --beacon.site my_site\n```\n\n- Or using the unreleased projects from GitHub from the main branch:\n\n```sh\nmix igniter.install \\\nbeacon@github:BeaconCMS/beacon,beacon_live_admin@github:BeaconCMS/beacon_live_admin \\\n--beacon.site my_site\n```\n\nReplace `my_site` with the names you want to generate and follow the prompts.\n\u003c/details\u003e\n\nTo finish, install dependencies, run the server, and open http://localhost:4000 to see the default home page or http://localhost:4000/admin to manage your new site.\n\n```sh\nmix setup\nmix phx.server\n```\n\nFor more info, check out the [guides and recipes](https://hexdocs.pm/beacon/installation.html). If you're new to Beacon you can start with [Your First Site](https://hexdocs.pm/beacon/your-first-site.html) guide.\n\n## Demo\n\nA sample application running latest Beacon is available at https://github.com/BeaconCMS/beacon_demo\n\n## Status\n\nYou can expect incomplete features and breaking changes before a stable v1.0 is released.\n\nMain components:\n- Core - A functional website can be built and deployed by inserting components in database and running a server, see https://github.com/BeaconCMS/beacon_demo\n- Admin - LiveView UI to manage layouts, pages, and all other resources. See https://github.com/BeaconCMS/beacon_live_admin\n- Page Builder - An easy to use, drag \u0026 drop UI for building pages, targeted to non-technical users. In the initial stages of development.\n\n## Contributing\n\nCheck out the [CONTRIBUTING.md](https://github.com/BeaconCMS/beacon/blob/main/CONTRIBUTING.md) doc for overall guidelines to contribute to this project,\nthen follow the [Local Development](https://github.com/BeaconCMS/beacon#local-development) steps to run a local project or watch the video below to understand more\nabout Beacon internals:\n\n\u003ca href=\"https://www.youtube.com/watch?v=5jk0fIJOFuc\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/BeaconCMS/beacon/main/assets/images/youtube_card.png\" width=\"512\" alt=\"YouTube card - ElixirConf 2023 - Leandro Pereira - Beacon: The next generation of CMS in Phoenix LiveView\"\u003e\n\u003c/a\u003e\n\n## Local Development\n\nThe file `dev.exs` is a self-contained Phoenix application running Beacon with sample data and code reloading enabled. Follow these steps to get a site up and running:\n\n1. Install dependencies, build assets, and run database setup:\n\n```sh\nmix setup\n```\n\n2. Execute the dev script:\n\n```sh\niex --sname core@localhost -S mix dev\n```\n\nNote that running a named node isn't required unless you're running Beacon LiveAdmin for local development as well.\n\nFinally, visit any of the routes defined in `dev.exs`, eg: http://localhost:4001/dev or http://localhost:4001/dev/sample\n\n## Looking for help with your Elixir project?\n\n\u003cimg src=\"assets/images/dockyard.png\" width=\"256\" alt=\"DockYard logo\"\u003e\n\nAt DockYard we are [ready to help you build your next Elixir project](https://dockyard.com/phoenix-consulting).\nWe have a unique expertise in Elixir and Phoenix development that is unmatched and we love to [write about Elixir](https://dockyard.com/blog/categories/elixir).\n\nHave a project in mind? [Get in touch](https://dockyard.com/contact/hire-us)!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeaconcms%2Fbeacon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeaconcms%2Fbeacon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeaconcms%2Fbeacon/lists"}