chaynHQ / soulmedicine

Soul Medicine a multilingual digital service designed to deliver critical safety information and supportive messaging in bite-sized pieces.
https://soulmedicine.io
MIT License
37 stars 9 forks source link

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

Closed tarebyte closed 1 year ago

tarebyte commented 1 year ago

Hello!

While I was working on https://github.com/chaynHQ/soulmedicine/pull/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 commented 1 year ago

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 commented 1 year ago

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

eleanorreem commented 1 year ago

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 😄

tarebyte commented 1 year ago

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.