Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct migration step in phx.gen.auth docs #5937

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Correct migration step in phx.gen.auth docs #5937

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions guides/authentication/mix_phx_gen_auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# mix phx.gen.auth

> This guide assumes that you have gone through the [introductory guides](overview.html) and have a Phoenix application [up and running](up_and_running.html).

The `mix phx.gen.auth` command generates a flexible, pre-built authentication system into your Phoenix app. This generator allows you to quickly move past the task of adding authentication to your codebase and stay focused on the real-world problem your application is trying to solve.

## Getting started

> Before running this command, consider committing your work as it generates multiple files.

Let's start by running the following command from the root of our app (or `apps/my_app_web` in an umbrella app):
Let's start by running the following command from the root of our app:

```console
$ mix phx.gen.auth Accounts User users
Expand All @@ -28,10 +30,10 @@ Since this generator installed additional dependencies in `mix.exs`, let's fetch
$ mix deps.get
```

Now we need to verify the database connection details for the development and test environments in `config/` so the migrator and tests can run properly. Then run the following to create the database:
Now run the pending repository migrations:

```console
$ mix ecto.setup
$ mix ecto.migrate
```

Let's run the tests to make sure our new authentication system works as expected.
Expand All @@ -40,7 +42,7 @@ Let's run the tests to make sure our new authentication system works as expected
$ mix test
```

And finally, let's start our Phoenix server and try it out.
And finally, let's start our Phoenix server and try it out (note the new `Register` and `Log in` links at the top right of the default page).

```console
$ mix phx.server
Expand Down
Loading