sahat
Update and improve docker instructions in readme.md
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.
hi @YasharF i would like to work for this task, could you please assign me?
@CodyBrat I would suggest starting by getting a hang of what hackathon starter is, and get it up and running first. Then let me know what you are thinking about.
I just had to turn down a PR that was just written by AI, so don't want the same thing to happen by more than one person.
@YasharF I haven't seen any updates on this issue yet. I’d like to add Docker configurations, including Docker development configs and setup instructions. Please let me know if I can contribute to this.
@YasharF I’ve finished implementing the Docker configurations and setup instructions. The changes are ready — please let me know if I can proceed with creating the PR.
Going to give @CodyBrat a couple of more days to address what I mentioned in https://github.com/sahat/hackathon-starter/pull/1409 before I reassign this.
@YasharF,
I’ve made the changes and am ready to raise a PR for review only. If you’d like, I can create the PR referencing this issue.
Sorry — I didn’t notice there was already an open PR for this issue earlier.
Separate note: While working on this, I found a broken link in the GitHub example. Can I create a new issue for it and have it assigned to me? I’ll work on it and fix it as soon as possible.
Issues with the Help Wanted label are the ones that I am looking to assign/take PRs for. Once an issue is assigned, I remove the Help Wanted label. I do add new issues every few days, and also may move an issue that is assigned back to the unassigned/Help Wanted state: https://github.com/sahat/hackathon-starter/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22
Thanks for the heads-up — I’ll keep that in mind moving forward.
Also, as I mentioned here, I’d like to work on that issue and fix it.
If you are interested in resolving this issue, please submit a PR; you don't need a formal assignment due to the small scope. PRs that indicate copy-paste of AI generated content, or AI content that was taken at face value will be marked as invalid or spam. Content includes all aspects of a submission ranging from code to even the text of the Pull request. The first PR that can be merged will be accepted.