feat: add gitpod setup & change readme

[anikdhabal]

fixes #136

Add gitpod setup and write readme documentation.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[dahal]

Amazing work on this @anikdhabal, however I am running into this error. I do see you are copying .env.example before the build.

Also, how does DB and SMTP connection really work with gitpod?

[anikdhabal]

Hey @dahal, thanks for the review. I noticed that you haven't been updating the .env.example and .gitpod.yml files during setup. You're encountering this error because when you open our repository in Gitpod, it automatically adds certain commands and a .gitpod.yml file and starts automatically. Because as of now we don't have a .gitpod.yml file.

So, could you please update the .env example and .gitpod.yml files? After updating the .gitpod.yml file, you should see a popup to validate the commands. After clicking it, validate our commands and redirect to a different page with the updated code setup.

Also, we receive all emails in Inbucket, which is accessible on port 9000.

[dahal]

Hey @dahal, thanks for the review. I noticed that you haven't been updating the .env.example and .gitpod.yml files during setup. You're encountering this error because when you open our repository in Gitpod, it automatically adds certain commands and a .gitpod.yml file and starts automatically.

So, could you please update the .env example and .gitpod.yml files? After updating the .gitpod.yml file, you should see a popup to validate the commands. After clicking it, validate our commands and redirect to a different page with the updated code setup.

Also, we receive all emails in Inbucket, which is accessible on port 9000.

Oh, thanks for the clarification, I didnot think of that. I initially clicked on the button which links to opencapco/opencap.co 's main and it does not have the updated .gitpod.yml 🤦‍♂️

Testing with your fork/branch worked. 🎉, this is amazing @anikdhabal , keep up the good work 👏👏👏

[anikdhabal]

Hey @dahal, thanks for the review. I noticed that you haven't been updating the .env.example and .gitpod.yml files during setup. You're encountering this error because when you open our repository in Gitpod, it automatically adds certain commands and a .gitpod.yml file and starts automatically.
So, could you please update the .env example and .gitpod.yml files? After updating the .gitpod.yml file, you should see a popup to validate the commands. After clicking it, validate our commands and redirect to a different page with the updated code setup.
Also, we receive all emails in Inbucket, which is accessible on port 9000.

Oh, thanks for the clarification, I didnot think of that. I initially clicked on the button which links to opencapco/opencap.co 's main and it does not have the updated .gitpod.yml 🤦‍♂️

Testing with your fork/branch worked. 🎉, this is amazing @anikdhabal , keep up the good work 👏👏👏

Thank you🙏. I will do best from my side.