Skip to content

docs: prepare final release submission documents#603

Merged
erinc00 merged 5 commits into
developmentfrom
doc/prepare-setup-docs
May 12, 2026
Merged

docs: prepare final release submission documents#603
erinc00 merged 5 commits into
developmentfrom
doc/prepare-setup-docs

Conversation

@kckagancan

Copy link
Copy Markdown
Contributor

Summary

This PR adds the final release submission documentation and environment example cleanup.

It updates the root setup instructions so evaluators can clearly run, configure, seed, and release the web/backend/mobile applications. It also adds/updates env example files for backend, web, and Android release configuration.

Changes

  • Updated root README.md with:

    • live deployment section
    • local Docker setup
    • backend setup
    • web setup
    • Android/mobile setup
    • production setup notes
    • data seeding instructions
    • default demo credentials
    • Android emulator network configuration
    • final release checklist
  • Updated env examples:

    • backend/.env.example
    • web/.env.example
    • android/.env.example
    • android/keystore.properties.example
  • Documented Android release configuration values and APK attachment requirement.

Notes

This is a docs/config-example only PR.

No application code, migrations, Docker config, Gradle config, package files, or lock files were changed.

Verification

  • Checked README coverage against the final software release submission checklist.
  • Confirmed documented env values match the current backend, web, and Android configuration expectations.

Closes #602

@kckagancan kckagancan changed the title doc: prepare submision documents doc: prepare submission documents May 12, 2026
@kckagancan kckagancan changed the title doc: prepare submission documents docs: prepare final release submission documents May 12, 2026

@erinc00 erinc00 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for your effort, LGTM, approved and merging

@erinc00 erinc00 merged commit d5cfd9f into development May 12, 2026
6 checks passed
@kckagancan kckagancan deleted the doc/prepare-setup-docs branch May 12, 2026 10:05
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