Skip to content

Update and improve docker instructions in readme.md #1404

@YasharF

Description

@YasharF

Update Oct 22: As we are approaching the end of October, I'll accept the first PR that is ready to be merged. No need for an exclusive issue assignment. Make sure to go over this entire issue description including its notes.


The instructions for setting up and using docker seem to be incomplete or might be even out of date.

Acceptance criteria:
As someone that is new to the project, a developer can

  • Follow the steps and run hackathon starter within docker.
  • Securely use their own credentials for at least one API and login provider, such as Github and Facebook.
  • Can load the app from their computer in a web browser, login and show the API example.

Note that most APIs and login providers require HTTPS (aka why we use ngrok, Cloudflare, etc. for https proxying), so the setup needs to consider that.
If working this issue, please obtain your own credentials and manually do end-to-end testing for your instructions before submitting the PR.

YOU NEED TO HAVE HACKATHON STARTER UP AND RUNNING AND HAVE A GOOD IDEA OF HOW IT WORKS, etc. DO NOT SUBMIT A PR THAT WAS WRITTEN BY AI.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions