Merge pull request #3770 from AlchemyCMS/feature/devcontainer

Add devcontainer and Docker Compose for local development

Author: tvdeyen

.devcontainer/Dockerfile

@@ -0,0 +1,23 @@
+FROM ruby:4.0
+
+RUN apt-get update && apt-get install -y \
+    libsqlite3-dev \
+    libjemalloc2 \
+    libvips \
+    imagemagick \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV LD_PRELOAD=libjemalloc.so.2
+ENV RUBY_YJIT_ENABLE=1
+
+RUN curl -fsSL https://bun.sh/install | bash
+ENV PATH="/root/.bun/bin:${PATH}"
+
+WORKDIR /workspace
+
+COPY Gemfile Gemfile.lock* alchemy_cms.gemspec ./
+COPY lib/alchemy/version.rb lib/alchemy/version.rb
+RUN bundle install
+
+COPY package.json bun.lock* ./
+RUN bun install

.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+  "name": "Alchemy CMS Development",
+  "dockerComposeFile": "../docker-compose.yml",
+  "service": "web",
+  "workspaceFolder": "/workspace",
+  "postCreateCommand": "bundle install && bun install && cd spec/dummy && bin/rails db:prepare",
+  "forwardPorts": [3000],
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "Shopify.ruby-lsp",
+        "esbenp.prettier-vscode",
+        "vitest.explorer"
+      ]
+    }
+  }
+}

CONTRIBUTING.md

@@ -29,20 +29,35 @@ Here's a quick guide:
 
 1. Fork the repo.
 
-2. Run the tests. We only take pull requests with passing tests, and it's great
+2. Set up your development environment. You can either use Docker or install
+dependencies locally:
+
+**Using Docker (recommended):**
+
+        $ docker compose build
+        $ docker compose up
+
+This starts the Rails dev server, Sass watcher, and JS bundle watcher.
+
+**Local setup:**
+
+        $ bin/setup
+        $ bin/start
+
+3. Run the tests. We only take pull requests with passing tests, and it's great
 to know that you have a clean slate:
 
         $ bundle exec rake
 
-3. Create new branch then make changes and add tests for your changes. Only
+4. Create new branch then make changes and add tests for your changes. Only
 refactoring and documentation changes require no new tests. If you are adding
 functionality or fixing a bug, we need tests!
 
-4. Push to your fork and submit a pull request. If the changes will apply cleanly
+5. Push to your fork and submit a pull request. If the changes will apply cleanly
 to the latest stable branches and main branch, you will only need to submit one
 pull request.
 
-5. If a PR does not apply cleanly to one of its targeted branches, then a separate
+6. If a PR does not apply cleanly to one of its targeted branches, then a separate
 PR should be created that does. For instance, if a PR applied to main & 2.7-stable but not 2.8-stable, then there should be one PR for main & 2.7-stable and another, separate PR for 2.8-stable.
 
 At this point you're waiting on us. We like to at least comment on, if not

README.md

@@ -310,7 +310,18 @@ If you want to contribute to Alchemy ([and we encourage you to do so](CONTRIBUTI
 
 ### Preparation
 
-First of all you need to clone your fork to your local development machine. Then you need to install the dependencies with bundler.
+First of all you need to clone your fork to your local development machine.
+
+**Using Docker (recommended):**
+
+```bash
+$ docker compose build
+$ docker compose up
+```
+
+This starts the Rails dev server, Sass watcher, and JS bundle watcher. The dev server is available at http://localhost:3000.
+
+**Local setup:**
 
 ```bash
 $ bin/setup

docker-compose.yml

@@ -0,0 +1,46 @@
+name: alchemy_cms
+
+services:
+  web:
+    build:
+      context: .
+      dockerfile: .devcontainer/Dockerfile
+    command: bash -c "cd spec/dummy && bin/rails db:prepare && bin/rails server -b 0.0.0.0"
+    ports:
+      - "3000:3000"
+    volumes:
+      - .:/workspace
+      - node_modules:/workspace/node_modules
+    depends_on:
+      - css
+      - js
+
+  sass:
+    build:
+      context: .
+      dockerfile: .devcontainer/Dockerfile
+    command: bun run --bun build:css --watch
+    volumes:
+      - .:/workspace
+      - node_modules:/workspace/node_modules
+
+  css:
+    build:
+      context: .
+      dockerfile: .devcontainer/Dockerfile
+    command: bash -c "cd spec/dummy && bin/rails dartsass:watch"
+    volumes:
+      - .:/workspace
+      - node_modules:/workspace/node_modules
+
+  js:
+    build:
+      context: .
+      dockerfile: .devcontainer/Dockerfile
+    command: bun run --bun build:admin:dev
+    volumes:
+      - .:/workspace
+      - node_modules:/workspace/node_modules
+
+volumes:
+  node_modules: