-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
107 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## MAC OS | ||
.DS_Store | ||
|
||
## TEXTMATE | ||
*.tmproj | ||
tmtags | ||
|
||
## EMACS | ||
*~ | ||
\#* | ||
.\#* | ||
|
||
## VIM | ||
*.swp | ||
|
||
## PROJECT::GENERAL | ||
coverage | ||
rdoc | ||
pkg | ||
.rvmrc | ||
|
||
## PROJECT::SPECIFIC | ||
data.sqlite3 | ||
sequel_data.sqlite3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
In this page you will find our recommended way of installing Docker on your machine. | ||
This guide is made for OSX users. | ||
|
||
## Install docker | ||
|
||
First install Docker using [Homebrew](https://brew.sh/) | ||
``` | ||
$ brew install docker | ||
``` | ||
|
||
You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one. | ||
|
||
## Setup your docker | ||
|
||
Install `docker-machine` | ||
``` | ||
$ brew install docker-machine | ||
``` | ||
|
||
Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine | ||
``` | ||
$ brew cask install virtualbox | ||
``` | ||
|
||
You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`. | ||
|
||
Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output) | ||
|
||
``` | ||
$ docker-machine create --driver virtualbox default | ||
$ docker-machine env default | ||
$ eval "$(docker-machine env default)" | ||
``` | ||
|
||
Now you're all setup to use our provided Docker image! | ||
|
||
## Build the image | ||
|
||
```bash | ||
docker build -t algolia-rails . | ||
``` | ||
|
||
## Run the image | ||
|
||
You need to provide few environment variables at runtime to be able to run the [Common Test Suite](https://github.com/algolia/algoliasearch-client-specs/tree/master/common-test-suite). | ||
You can set them up directly in the command: | ||
|
||
```bash | ||
docker run -it --rm --env ALGOLIA_APP_ID=XXXXXX [...] -v $PWD:/app -w /app algolia-rails bash | ||
``` | ||
|
||
However, we advise you to export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables. | ||
|
||
```bash | ||
docker run -it --rm --env ALGOLIA_APPLICATION_ID \ | ||
--env ALGOLIA_API_KEY \ | ||
-v $PWD:/app -w /app algolia-rails bash | ||
``` | ||
|
||
Once your container is running, any changes you make in your IDE are directly reflected in the container. | ||
|
||
To launch the tests, you can use one of the following commands | ||
```shell script | ||
|
||
# run the whole test suite | ||
bundle exec rspec | ||
|
||
# run a single test | ||
bundle exec rspec ./path/to/test_spec.rb:#line_number | ||
``` | ||
|
||
Feel free to contact us if you have any questions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
FROM ruby:2.6.3 | ||
|
||
RUN gem install bundler | ||
|
||
WORKDIR /app | ||
COPY . /app/ | ||
RUN bundle install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters