Skip to content

Commit

Permalink
Updates to release notes and up and running
Browse files Browse the repository at this point in the history
  • Loading branch information
josevalim committed Dec 4, 2024
1 parent a2d0c83 commit 5e62a39
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 5 deletions.
6 changes: 4 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release Instructions

1. Check related deps for required version bumps and compatibility (`phoenix_ecto`, `phoenix_pubsub_redis`, `phoenix_html`)
1. Check related deps for required version bumps and compatibility (`phoenix_ecto`, `phoenix_html`)
2. Bump version in related files below
3. Bump external dependency version in related external files below
4. Run tests:
Expand All @@ -10,7 +10,8 @@
6. Publish `phx_new` and `phoenix` packages and docs after pruning any extraneous uncommitted files
7. Test installer by generating a new app, running `mix deps.get`, and compiling
8. Publish to `npm` with `npm publish`
9. Start -dev version in related files below
9. Update Elixir and Erlang/OTP versions on new.phoenixframework.org
10. Start -dev version in related files below

## Files with version

Expand All @@ -21,5 +22,6 @@
* `assets/package.json`

## Files with external dependency versions

* `priv/templates/phx.gen.release/Docker.eex` (debian)
* `priv/templates/phx.gen.release/Docker.eex` (esbuild)
30 changes: 27 additions & 3 deletions guides/introduction/up_and_running.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,34 @@
# Up and Running

Let's get a Phoenix application up and running as quickly as possible.
There are two mechanisms to start a new Phoenix application: the express option, supported on some OSes, and via `mix phx.new`. Let's check it out.

Before we begin, please take a minute to read the [Installation Guide](installation.html). By installing any necessary dependencies beforehand, we'll be able to get our application up and running smoothly.
## Phoenix Express

We can run `mix phx.new` from any directory in order to bootstrap our Phoenix application. Phoenix will accept either an absolute or relative path for the directory of our new project. Assuming that the name of our application is `hello`, let's run the following command:
A single command will get you up and running in seconds:

For macOS/Ubuntu:

```bash
$ curl https://new.phoenixframework.org/myapp | sh
```

For Windows PowerShell:

```cmd
> curl.exe -fsSO https://new.phoenixframework.org/myapp.bat; .\myapp.bat
```

The above will install Erlang, Elixir, and Phoenix, and generate a fresh Phoenix application. It will also automatically pick one of PostgreSQL or MySQL as the database, and fallback to SQLite if none of them are available. Once the command above, it will open up a Phoenix application, with the steps necessary to complete your installation.

> Your Phoenix application name is taken from the path.
If your operating system is not supported, or the command above fails, don't fret! You can still start your Phoenix application using `mix phx.new`.

## Via `mix phx.new`

In order to create a new Phoenix application, you will need to install Erlang, Elixir, and Phoenix. See the [Installation Guide](installation.html) for more information. If you share your application with someone, they will also need to follow the Installation Guide steps to set it all up.

Once you are ready, you can run `mix phx.new` from any directory in order to bootstrap our Phoenix application. Phoenix will accept either an absolute or relative path for the directory of our new project. Assuming that the name of our application is `hello`, let's run the following command:

```console
$ mix phx.new hello
Expand Down

0 comments on commit 5e62a39

Please sign in to comment.