Skip to content

The easiest way to get started with Elixir and Phoenix Framework

Notifications You must be signed in to change notification settings

optimumBA/phx.tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jan 15, 2025
098d3a0 · Jan 15, 2025

History

55 Commits
Dec 6, 2024
Nov 22, 2024
Jun 29, 2024
Dec 6, 2024
Jan 15, 2025
Jun 29, 2024
Nov 22, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Jun 29, 2024
Nov 15, 2024
Jan 1, 2025
Jan 1, 2025
Apr 9, 2024
Sep 18, 2024
Jun 29, 2024
Sep 20, 2024
Aug 5, 2024
Dec 6, 2024

Repository files navigation

PhxTools

phx.tools is a shell script for platforms Linux and macOS (sorry, Windows users) that configures the development environment for you in a few easy steps.

Once you finish running the script, you'll be able to start the database server, create a new Phoenix application, and launch the server.

Here are the tools that phx.tools will install for you, if not already installed:

Required

  • Build dependencies
  • Homebrew (only on macOS)
  • mise
  • Erlang
  • Elixir
  • Phoenix
  • PostgreSQL

Setup

To start your Phoenix server:

  • install Elixir, Erlang and Node using mise
    • install mise using either curl https://mise.run | sh or brew install mise
    • make sure to activate it
    • run mise install
  • run mix setup
  • start Phoenix server with mix phx.server

Now you can visit localhost:4000 from your browser.

Docs

  • execute mix docs --formatter html --open

It will open documentation in your browser.

Running tests

  • run mix coveralls or mix coveralls.html

Contributing

Make sure to execute make ci in order to run all the checks before committing the code.