Merge #251

251: Add a docker-composer file for local development r=curquiza a=thicolares

Closes #250.

Co-authored-by: Thiago Colares <[email protected]>
Co-authored-by: Clémentine Urquizar - curqui <[email protected]>

Author: 3 people

CONTRIBUTING.md

@@ -89,6 +89,24 @@ To update it, run the following command:
 bundle exec rubocop --auto-gen-config
 ```
 
+### Using Docker Compose <!-- omit in toc -->
+
+If you have Docker and Docker Compose installed, you can alternatively set up your local development environment following the steps below.
+
+```bash
+# Create/run the containers
+docker compose up -d
+# Run bash in meilisearch_ruby container
+docker compose exec meilisearch_ruby bash
+```
+
+You can now run the previous steps in the `meilisearc_ruby` container:
+
+```bash
+bundle install
+bundle exec rspec
+bundle exec rubocop lib/ spec/
+...
 ### Want to debug? <!-- omit in toc -->
 
 You can use the [`byebug` gem](https://github.com/deivid-rodriguez/byebug).

docker-compose.yml

@@ -0,0 +1,26 @@
+version: "3.7"
+
+services:
+  meilisearch_ruby:
+    image: ruby
+    tty: true
+    stdin_open: true
+    working_dir: /home/app
+    environment:
+      - MEILISEARCH_HOST=meilisearch
+      - MEILISEARCH_PORT=7700
+    ports:
+      - "3001:3000"
+    volumes:
+      - ./:/home/app
+
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    tty: true
+    stdin_open: true
+    container_name: meilisearch
+    ports:
+      - "7700:7700"
+    # Uncomment this to run the test suite
+    # environment:
+    #   - MEILI_MASTER_KEY=masterKey

spec/spec_helper.rb

@@ -28,7 +28,8 @@
 require 'byebug'
 
 # Globals for all tests
-URL = 'http://localhost:7700'
+URL = format('http://%<host>s:%<port>s',
+             host: ENV.fetch('MEILISEARCH_HOST', 'localhost'), port: ENV.fetch('MEILISEARCH_PORT', '7700'))
 MASTER_KEY = 'masterKey'
 DEFAULT_SEARCH_RESPONSE_KEYS = [
   'hits',