Skip to content

doc: Update local setup for make setup and localhost migration#5785

Open
fungc-io wants to merge 1 commit into
authgear:mainfrom
fungc-io:doc-simplify-setup-contributing
Open

doc: Update local setup for make setup and localhost migration#5785
fungc-io wants to merge 1 commit into
authgear:mainfrom
fungc-io:doc-simplify-setup-contributing

Conversation

@fungc-io

Copy link
Copy Markdown
Member

Updates CONTRIBUTING.md to reflect the simplified local setup from #5783.

Changes

  • New "Quick setup" section documenting make setup (= make vendor + scripts/sh/setup-dev.sh), including prerequisites (docker/podman, jq) and the ADMIN_EMAIL/ADMIN_PASSWORD overrides.
  • Migrated all local hostnames from portal.localhost:8000 / accounts.portal.localhost:3100 to plain localhost:8000 / localhost:3100, matching the changes to .env.example, nginx.conf, and the init command. The /etc/hosts editing step is no longer needed and has been reframed accordingly.
  • Added skip notes to the manual sections (Set up environment, Create an account) pointing readers who used make setup to Run, and trimmed the now-unused accounts.portal.localhost custom-domain command.

Docs only — no code changes.

ref DEV-3657

Reflect PR authgear#5783 in CONTRIBUTING.md: add a Quick setup section for
make setup, migrate local URLs from portal.localhost/accounts.portal.localhost
to plain localhost (no more /etc/hosts editing), and add skip notes to the
manual sections.

ref DEV-3657
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.

1 participant