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

Add a Development Container for a more seamless local experience #306

Merged
merged 8 commits into from
Jul 19, 2023

Conversation

tarebyte
Copy link
Contributor

@tarebyte tarebyte commented Jul 2, 2023

Hello!

While I was working on #305 and getting my local environment ready to go, I noticed that there were a lot of dependencies to get setup.

In order to make it easier to contribute, I thought it might be nice to have a way to run it all locally only relying on Docker and potentially VSCode if that is your editor of choice.

This Pull Request introduces a Dev Container for running the application without having to install any of the necessary dependencies on your machine. It uses the existing services defined in docker-compose.yml so that the services running are consistent.

Here's what it looks like in VSCode.

Screenshot 2023-07-02 at 11 49 13 Screenshot 2023-07-02 at 12 06 04

Thanks to using Ubuntu Jammy as the base image, this can support ARM and Intel based machines.

If this is a path we'd like to move forward with, I'm happy to make changes to the README to show this as an option when getting started.

Thanks!

@eleanorreem
Copy link
Contributor

Hey ! Thank you for this! I didn't have my notifications turned on so I didn't see this PR. This all makes sense to me. I will look through this today

@tarebyte
Copy link
Contributor Author

No rush at all, thanks so much for taking a look!

@eleanorreem
Copy link
Contributor

eleanorreem commented Jul 13, 2023

I think this approach is great. I didn't know about dev containers so this is a great new addition. Thank you! I couldn't quite get this one working (most likely my lack of understanding) but I assume with start up instructions that I will be able to 😄

Copy link
Contributor

@issyl0 issyl0 left a comment

Choose a reason for hiding this comment

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

This works for me!

@tarebyte
Copy link
Contributor Author

Thank you! I couldn't quite get this one working (most likely my lack of understanding) but I assume with start up instructions that I will be able to 😄

I'll update the README/documentation before merging.

@tarebyte tarebyte force-pushed the tarebyte/create-devcontainer branch from ab12f40 to d587128 Compare July 19, 2023 17:23
@tarebyte tarebyte merged commit 662b9e3 into chaynHQ:master Jul 19, 2023
@tarebyte tarebyte deleted the tarebyte/create-devcontainer branch July 19, 2023 17:44
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.

3 participants