{"id":48238584,"url":"https://github.com/team-alembic/phx_install","last_synced_at":"2026-04-04T20:11:38.501Z","repository":{"id":345404793,"uuid":"1147651119","full_name":"team-alembic/phx_install","owner":"team-alembic","description":"Composable Igniter installers for Phoenix","archived":false,"fork":false,"pushed_at":"2026-03-29T22:47:56.000Z","size":227,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-30T01:00:03.603Z","etag":null,"topics":["boilerplate","elixir","igniter","phoenix","phoenix-framework","starter-kit","templates"],"latest_commit_sha":null,"homepage":"https://alembic.com.au","language":"Elixir","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/team-alembic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","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":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-02T03:28:47.000Z","updated_at":"2026-03-29T22:48:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/team-alembic/phx_install","commit_stats":null,"previous_names":["team-alembic/phx_install"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/team-alembic/phx_install","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-alembic%2Fphx_install","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-alembic%2Fphx_install/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-alembic%2Fphx_install/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-alembic%2Fphx_install/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/team-alembic","download_url":"https://codeload.github.com/team-alembic/phx_install/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/team-alembic%2Fphx_install/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31412092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T20:09:54.854Z","status":"ssl_error","status_checked_at":"2026-04-04T20:09:44.350Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["boilerplate","elixir","igniter","phoenix","phoenix-framework","starter-kit","templates"],"created_at":"2026-04-04T20:11:36.382Z","updated_at":"2026-04-04T20:11:38.493Z","avatar_url":"https://github.com/team-alembic.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Phoenix Installer\n\n[![CI](https://github.com/team-alembic/phx_install/actions/workflows/ci.yml/badge.svg)](https://github.com/team-alembic/phx_install/actions/workflows/ci.yml)\n[![License: Apache 2.0](https://img.shields.io/badge/License-Apache--2.0-green.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Hex version badge](https://img.shields.io/hexpm/v/phx_install.svg)](https://hex.pm/packages/phx_install)\n[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/phx_install)\n\nAn alternative to `mix phx.new` that installs Phoenix into any Elixir project — new or existing — using [Igniter](https://hex.pm/packages/igniter) for AST-aware code generation.\n\nInstead of generating a project from a template, phx_install composes individual installer tasks that each add a specific feature (endpoint, router, LiveView, etc.). Each task manipulates your project's actual AST, so it can safely merge into existing code rather than overwriting it.\n\n## Quick Start\n\n### Existing Project\n\nInstall the default Phoenix stack (LiveView, assets, Gettext, LiveDashboard) into your project:\n\n```bash\nmix igniter.install phx_install\n```\n\nSee [Options](#options) for flags to customise what gets installed.\n\nTo add the dependency without running the installer, and then explore the available tasks:\n\n```bash\nmix igniter.add phx_install\nmix help phx.install\n```\n\n### New Project\n\nCreate a new Elixir application with Phoenix installed:\n\n```bash\nmix igniter.new my_app --install phx_install\n```\n\n## How It Differs from `mix phx.new`\n\n`mix phx.new` is the standard Phoenix generator — it creates a complete project from a template and is the right choice for most greenfield apps. phx_install takes a different approach that's useful when you want to:\n\n- **Add Phoenix to an existing Elixir project** — phx_install merges Phoenix into your current code rather than starting from a fresh project.\n- **Install features incrementally** — start with an API-only app and add LiveView later with `mix phx.install.live`.\n- **Run it again safely** — every task is idempotent. Running it twice won't duplicate code or overwrite your changes.\n\n## Options\n\nBy default, `mix phx.install` sets up a full Phoenix application with LiveView, assets, Gettext, and LiveDashboard. Use flags to opt out:\n\n```bash\n# API-only (no LiveView, no assets)\nmix phx.install --no-live --no-assets\n\n# Skip internationalisation\nmix phx.install --no-gettext\n\n# Skip LiveDashboard\nmix phx.install --no-dashboard\n```\n\nDatabase and email support are separate tasks you can add at any time:\n\n```bash\n# Ecto with PostgreSQL (default), MySQL, or SQLite\nmix phx.install.ecto\nmix phx.install.ecto --adapter mysql\nmix phx.install.ecto --adapter sqlite\n\n# Swoosh email\nmix phx.install.mailer\n```\n\n## Individual Tasks\n\nEach feature is a standalone task. The orchestrator (`mix phx.install`) composes them, but you can also run them independently:\n\n| Task                    | Description                                            |\n|-------------------------|--------------------------------------------------------|\n| `phx.install.core`      | Application module, config files, base dependencies    |\n| `phx.install.endpoint`  | Phoenix.Endpoint, Telemetry, web module                |\n| `phx.install.router`    | Router with pipelines, error handling                  |\n| `phx.install.html`      | HTML components, layouts, error pages                  |\n| `phx.install.live`      | LiveView socket, helpers, and macros (composes `html`) |\n| `phx.install.assets`    | esbuild and Tailwind CSS                               |\n| `phx.install.gettext`   | Internationalisation with Gettext                      |\n| `phx.install.dashboard` | Phoenix LiveDashboard (dev only)                       |\n| `phx.install.ecto`      | Ecto database support with Repo                        |\n| `phx.install.mailer`    | Swoosh email support                                   |\n\n## Development\n\n```bash\n# Run tests\nmix test\n\n# Run acceptance tests (generates phx.new projects for comparison)\nmix test --include acceptance\n```\n\n## Licence\n\nApache-2.0\n\n---\n\n[![Alembic](logos/alembic.svg)](https://alembic.com.au)\n\nProudly written and maintained by the team at [Alembic](https://alembic.com.au) for the Elixir community.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam-alembic%2Fphx_install","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteam-alembic%2Fphx_install","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteam-alembic%2Fphx_install/lists"}