@supabase/phoenix

Peace of mind from prototype to production.

Supabase Fork

This is a Supabase fork of Phoenix Framework, published to npm as @supabase/phoenix.

Installation:

npm install @supabase/phoenix

Releases: This fork uses automated releases via release-please. See RELEASE.md for details.

Upstream: Based on phoenixframework/phoenix

Versioning

This package uses independent semantic versioning for the JavaScript client.

• Based on: Phoenix Framework 1.8.3 JS client
• Last synced: 2026-02-17

We version based on JS API changes only, not upstream Phoenix framework releases. When we merge upstream Phoenix changes, we evaluate the JS API impact and version accordingly.

Getting started

See the official site at https://www.phoenixframework.org/.

Install the latest version of Phoenix by following the instructions at https://hexdocs.pm/phoenix/installation.html#phoenix.

Documentation

API documentation is available at https://hexdocs.pm/phoenix.

Phoenix.js documentation is available at https://hexdocs.pm/phoenix/js.

Contributing

We appreciate any contribution to Phoenix. Check our CODE_OF_CONDUCT.md and CONTRIBUTING.md guides for more information. We usually keep a list of features and bugs in the issue tracker.

Generating a Phoenix project from unreleased versions

You can create a new project using the latest Phoenix source installer (the phx.new Mix task) with the following steps:

• Remove any previously installed phx_new archives so that Mix will pick up the local source code. This can be done with mix archive.uninstall phx_new or by simply deleting the file, which is usually in ~/.mix/archives/.
• Copy this repo via git clone https://github.com/phoenixframework/phoenix or by downloading it
• Run the phx.new Mix task from within the installer directory, for example:

cd phoenix/installer
mix phx.new dev_app --dev

The --dev flag will configure your new project's :phoenix dep as a relative path dependency, pointing to your local Phoenix checkout:

defp deps do
  [{:phoenix, path: "../..", override: true},

To create projects outside of the installer/ directory, add the latest archive to your machine by following the instructions in installer/README.md

Building from source

To build the documentation:

npm install
MIX_ENV=docs mix docs

To build Phoenix:

mix deps.get
mix compile

To build the Phoenix installer:

mix deps.get
mix compile
mix archive.build

To build Phoenix.js:

cd assets
npm install

Important links

• #elixir on Libera IRC

• elixir-lang Slack channel

• Issues tracker

• Phoenix Forum (questions and proposals)

• Visit Phoenix's sponsor, DockYard, for expert Phoenix Consulting

Copyright and License

Copyright (c) 2014, Chris McCord.

Phoenix source code is licensed under the MIT License.