Skip to content

Commit

Permalink
tweak phx.new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mayel committed Apr 23, 2024
1 parent e8b65dc commit f97d3e4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions guides/introduction/up_and_running.md
Expand Up @@ -10,8 +10,8 @@ We can run `mix phx.new` from any directory in order to bootstrap our Phoenix ap
$ mix phx.new hello
```

> A note about what's included: By default `mix phx.new` adds a number of optional libraries and generates the config and integration code needed in your application, for example:
> - [Ecto](ecto.html) allows our Phoenix application to communicate with a data store, such as PostgreSQL, MySQL, and others. If our application will not require this component we can skip this dependency by passing the `--no-ecto` flag to `mix phx.new`.
> A note about what's included: By default `mix phx.new` adds a number of optional dependencies and generates the necessary config and integration code in our application, for example:
> - [Ecto](ecto.html) for communicating with a data store, such as PostgreSQL, MySQL, and others. If our application will not require this component we can skip this dependency by passing the `--no-ecto` flag to `mix phx.new`.
> - [Phoenix.HTML](https://hexdocs.pm/phoenix_html/Phoenix.HTML.html), [TailwindCSS](https://tailwindcss.com), and [Esbuild](https://esbuild.github.io) for basic web applications, which you can exclude with `--no-html` and `--no-assets` for API-only applications.
> - [Phoenix.LiveView](https://hexdocs.pm/phoenix_live_view/) for interactive web applications, which you can exclude with `--no-live`.
> - Read the [Mix Tasks Guide](mix_tasks.html#phoenix-specific-mix-tasks) for the full list of things that can be excluded, among other options.
Expand Down
2 changes: 1 addition & 1 deletion installer/lib/mix/tasks/phx.new.ex
Expand Up @@ -53,7 +53,7 @@ defmodule Mix.Tasks.Phx.New do
* `--no-html` - do not generate HTML views
* `--no-live` - comment out LiveView socket setup in in your Endpoint
* `--no-live` - comment out LiveView socket setup in your Endpoint
and assets/js/app.js. Automatically disabled if --no-html is given
* `--no-mailer` - do not generate Swoosh mailer files
Expand Down

0 comments on commit f97d3e4

Please sign in to comment.