Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Support Github Codespaces #2510

Merged
merged 9 commits into from
Jun 29, 2021
Merged

Chore: Support Github Codespaces #2510

merged 9 commits into from
Jun 29, 2021

Conversation

sojan-official
Copy link
Member

@sojan-official sojan-official commented Jun 24, 2021

This PR builds on top of the previous work which we did for GitHub codespace. Now that publically accessible ports are available in codespaces, You can get a complete chatwoot development environment up and running in a few minutes.

Changes

  • Bump up the Ruby version of the Chatwoot app ( since the base image published for codespace is on 2.7.3)
  • Github action to publish the base image to container registry
  • Move the steps in the old Dockerfile to the base image, so the codespaces now boot up super fast.

Notes

  • The base image used currently published under my personal Github. Let's change that to chatwoot in a subsequent PR after we get this one merged.

Instructions to test

Creating Codespace

  • Head over to your codespaces section in GitHub and create a codespace for chatwoot:chore/codespace
  • GitHub will open up the codespace in VSCode once the build finishes

Booting for the First Time

  • In the ports tab in the visual studio, add 3000, 8025 and make them public

  • Edit the .env file and update the following values

    • update frontend URL environment variable with the public URL for port 3000 ( copy from vs code ports tab)
    • update values for Postgres, Mailhog and Redis hosts to localhost ( to be automated in future)
  • In terminal run bundle exec rake db:reset

  • run yarn

Development Workflow

  • start rails server by running overmind start -f Procfile.dev
  • load the public URL for port 3000, and your chatwoot instance will available to test the changes

Notes

  • You can access the emails using the public URL for Mailhog (port 8025)
  • When using a ruby debugger, use overmind connect backend or overmind connect worker
  • if you see webpack manifest error, wait a minute for the asset complication to finish

chatwoot-codespace.mp4

@pr-triage pr-triage bot added the PR: draft The pull request is not ready to be reviewed label Jun 24, 2021
@sojan-official sojan-official marked this pull request as ready for review June 25, 2021 13:35
@pr-triage pr-triage bot added PR: unreviewed This pull request is yet to be reviewed. and removed PR: draft The pull request is not ready to be reviewed labels Jun 25, 2021
@pr-triage pr-triage bot added PR: partially-approved Not all reviewers have approved the PR and removed PR: unreviewed This pull request is yet to be reviewed. labels Jun 29, 2021
@pranavrajs pranavrajs merged commit fa37f8e into develop Jun 29, 2021
@pranavrajs pranavrajs deleted the chore/codespace branch June 29, 2021 13:48
@pr-triage pr-triage bot added PR: merged The pull request is merged to another branch and removed PR: partially-approved Not all reviewers have approved the PR labels Jun 29, 2021
@github-actions
Copy link

github-actions bot commented Aug 9, 2022

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
PR: merged The pull request is merged to another branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants