Skip to content

docs: Add getting started guide for email authentication setup#560

Draft
Zfinix wants to merge 2 commits into
mainfrom
docs/simple-email-auth-setup
Draft

docs: Add getting started guide for email authentication setup#560
Zfinix wants to merge 2 commits into
mainfrom
docs/simple-email-auth-setup

Conversation

@Zfinix
Copy link
Copy Markdown
Contributor

@Zfinix Zfinix commented May 29, 2026

No description provided.

Copy link
Copy Markdown
Collaborator

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks clean! Added a few comments.

@@ -0,0 +1,92 @@
# Setup
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider a more descriptive title. Setup was also used the old page, which keeps it as a filename, which is a bit conflicting.

- Docker installed and running, so the server can start its database.
- The Flutter SDK installed, so you can run the app.

## What you get out of the box
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole "What you get out of the box" is a filler not needed. It repeats what is already said at the top. Remove it.


```bash
cd my_project_server
docker compose up --build --detach
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docker and dart run is not relevant for 3.5. Update to conform to latest version.


```bash
cd my_project_flutter
flutter run
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No Flutter run needed in latest version.

@@ -1,6 +1,10 @@
# Setup
# Migrate to the new auth module
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this will be the migration guide, we need to fully test it as that and take the other attempts at migration guides into consideration (ie the old PR still hanging)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants