phoenix

To help you get started, we've collected the most common ways that phoenix is being used within popular public projects.

flow-typed / flow-typed / definitions / npm / phoenix_v1.4.x / test_phoenix_v1.4.x.js View on Github

it('sets up presence correctly', () => {
    const socket = new Socket('/socket', { params: { userToken: '456' } });
    socket.connect();
    const channel = socket.channel('room:123', { token: 'xyz' });
    channel.join();
    const presence = new Presence(channel);

    // detect if user has joined for the 1st time or from another tab/device
    presence.onJoin((id, current, newPres) => {
      if (!current) {
        console.log('user has entered for the first time', newPres);
      } else {
        console.log('user additional presence', newPres);
      }
    });

    // detect if user has left from all tabs/devices, or is still present
    presence.onLeave((id, current, leftPres) => {
      if (current && current.metas && current.metas.length === 0) {
        console.log('user has left from all devices', leftPres);
      } else {
        console.log('user left from a device', leftPres);

View more ways to use phoenix

> Peace of mind from prototype to production.

Getting started

See the official site at .

Install the latest version of Phoenix by following the instructions at .

Phoenix requires Elixir v1.11+ & Erlang v22.1+.

Documentation

API documentation is available at .

Phoenix.js documentation is available at .

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:

1. 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/.
2. Copy this repo via git clone https://github.com/phoenixframework/phoenix or by downloading it
3. 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

To build the documentation from source:

npm install --prefix assets
MIX_ENV=docs mix docs

To build Phoenix from source:

mix deps.get
mix compile

To build the Phoenix installer from source:

mix deps.get
mix compile
mix archive.build

Building 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.