Skip to content

QUICKSTART.md

Latest commit

 

History

History
52 lines (34 loc) · 1.74 KB

QUICKSTART.md

File metadata and controls

52 lines (34 loc) · 1.74 KB

Quickstart (Phoenix-first)

The documented subset is considered stable in v1.x. This quickstart helps Phoenix developers get productive quickly while clearly flagging experimental surfaces.

If you’re new to Haxe and/or new to Phoenix, start here first:

  • docs/01-getting-started/START_HERE.md

Pick a Path

  • New Phoenix app (greenfield): docs/06-guides/PHOENIX_NEW_APP.md
  • Existing Phoenix app (gradual adoption): docs/06-guides/PHOENIX_GRADUAL_ADOPTION.md
  • Learn by example: examples/README.md (start with examples/03-phoenix-app/, then compare hybrid examples/12-phoenix-chat/ vs Haxe-first examples/15-phoenix-chat-haxe-first/)

Prerequisites

  • Elixir 1.14+
  • Node.js 16+ (for lix and JS toolchain)
  • Haxe 4.3.7+ on your PATH
  • Postgres (required for examples/todo-app and any Phoenix app using Ecto)

If you don’t have Haxe installed yet, start here: docs/01-getting-started/installation.md.

One-Minute Smoke Test (using the repo’s todo-app)

This requires a working Postgres connection (defaults are postgres/postgres in the example config).

cd examples/todo-app
mix setup

Recommended bounded smoke (from repo root, non-blocking):

npm run qa:sentinel
scripts/qa-logpeek.sh --run-id <RUN_ID> --until-done 600

Manual dev run (foreground server):

cd examples/todo-app
mix phx.server

Open http://localhost:4000 (default dev port).

Important Notes

  • Prefer haxe ... (your local Haxe toolchain); if it’s not on your PATH, use the repo shim: ./node_modules/.bin/haxe ... (provided by lix + .haxerc).
  • Do not use -D analyzer-optimize for the Elixir target; it produces non-idiomatic output and can break functional shapes. See docs/01-getting-started/compiler-flags-guide.md.