Skip to content

Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences

Use docker for consistent build environment

Jason Boscoc1fc486bf767
diff --git a/README.md b/README.md
index f2decb9b..92aca9fd 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,16 @@ Typesense is an open source search engine for building a delightful search exper
- **Blazing fast:** Meticulously designed and optimized for speed
- **Simple and delightful:** Simple API, delightful out-of-the-box experience
-## Building Typesense from source
+## Development
-Please ensure that you have `cmake` available on your system. All other dependencies are built automatically.
+### Build from source
+
+Please ensure that you have docker installed on your system.
```
-./build.sh
+$ ./build.sh
```
+We use [dockcross](https://github.com/dockcross/dockcross) to build our development environment consistently.
+
© 2016-2017 Wreally Studios Inc.
\ No newline at end of file
diff --git a/build.sh b/build.sh
index 4ff35e25..2364ec8a 100755
--- a/build.sh
+++ b/build.sh
@@ -1,10 +1,17 @@
#!/bin/sh
+set -o xtrace
+
PROJECT_DIR=`dirname $0`
if [ "$1" == "--clean" ]; then
rm -rf $PROJECT_DIR/build
mkdir $PROJECT_DIR/build
+
+ # rm -rf $PROJECT_DIR/external
+ # DOCKER_NO_CACHE=" --no-cache"
fi
-cmake -H$PROJECT_DIR -B$PROJECT_DIR/build
-make -C $PROJECT_DIR/build
\ No newline at end of file
+docker build --file $PROJECT_DIR/docker/development.Dockerfile --tag wreally/typesense-development $DOCKER_NO_CACHE $PROJECT_DIR/docker
+
+./dockcross --image wreally/typesense-development cmake -H$PROJECT_DIR -B$PROJECT_DIR/build
+./dockcross --image wreally/typesense-development make -C $PROJECT_DIR/build
\ No newline at end of file
diff --git a/dockcross b/dockcross
new file mode 100755
index 00000000..536edd31
--- /dev/null
+++ b/dockcross
@@ -0,0 +1,234 @@
+#!/bin/bash
+
+DEFAULT_DOCKCROSS_IMAGE=dockcross/linux-x64
+
+#------------------------------------------------------------------------------
+# Helpers
+#
+err() {
+ echo -e >&2 ERROR: $@\\n
+}
+
+die() {
+ err $@
+ exit 1
+}
+
+has() {
+ # eg. has command update
+ local kind=$1
+ local name=$2
+
+ type -t $kind:$name | grep -q function
+}
+
+#------------------------------------------------------------------------------
+# Command handlers
+#
+command:update-image() {
+ docker pull $FINAL_IMAGE
+}
+
+help:update-image() {
+ echo Pull the latest $FINAL_IMAGE .
+}
+
+command:update-script() {
+ if cmp -s <( docker run --rm $FINAL_IMAGE ) $0; then
+ echo $0 is up to date
+ else
+ echo -n Updating $0 '... '
+ docker run --rm $FINAL_IMAGE > $0 && echo ok
+ fi
+}
+
+help:update-image() {
+ echo Update $0 from $FINAL_IMAGE .
+}
+
+command:update() {
+ command:update-image
+ command:update-script
+}
+
+help:update() {
+ echo Pull the latest $FINAL_IMAGE, and then update $0 from that.
+}
+
+command:help() {
+ if [[ $# != 0 ]]; then
+ if ! has command $1; then
+ err \"$1\" is not an dockcross command
+ command:help
+ elif ! has help $1; then
+ err No help found for \"$1\"
+ else
+ help:$1
+ fi
+ else
+ cat >&2 <<ENDHELP
+Usage: dockcross [options] [--] command [args]
+
+By default, run the given *command* in an dockcross Docker container.
+
+The *options* can be one of:
+
+ --args|-a Extra args to the *docker run* command
+ --image|-i Docker cross-compiler image to use
+ --config|-c Bash script to source before running this script
+
+
+Additionally, there are special update commands:
+
+ update-image
+ update-script
+ update
+
+For update command help use: $0 help <command>
+ENDHELP
+ exit 1
+ fi
+}
+
+#------------------------------------------------------------------------------
+# Option processing
+#
+special_update_command=''
+while [[ $# != 0 ]]; do
+ case $1 in
+
+ --)
+ break
+ ;;
+
+ --args|-a)
+ ARG_ARGS="$2"
+ shift 2
+ ;;
+
+ --config|-c)
+ ARG_CONFIG="$2"
+ shift 2
+ ;;
+
+ --image|-i)
+ ARG_IMAGE="$2"
+ shift 2
+ ;;
+ update|update-image|update-script)
+ special_update_command=$1
+ break
+ ;;
+ -*)
+ err Unknown option \"$1\"
+ command:help
+ exit
+ ;;
+
+ *)
+ break
+ ;;
+
+ esac
+done
+
+# The precedence for options is:
+# 1. command-line arguments
+# 2. environment variables
+# 3. defaults
+
+# Source the config file if it exists
+DEFAULT_DOCKCROSS_CONFIG=~/.dockcross
+FINAL_CONFIG=${ARG_CONFIG-${DOCKCROSS_CONFIG-$DEFAULT_DOCKCROSS_CONFIG}}
+
+[[ -f "$FINAL_CONFIG" ]] && source "$FINAL_CONFIG"
+
+# Set the docker image
+FINAL_IMAGE=${ARG_IMAGE-${DOCKCROSS_IMAGE-$DEFAULT_DOCKCROSS_IMAGE}}
+
+# Handle special update command
+if [ "$special_update_command" != "" ]; then
+ case $special_update_command in
+
+ update)
+ command:update
+ exit $?
+ ;;
+
+ update-image)
+ command:update-image
+ exit $?
+ ;;
+
+ update-script)
+ command:update-script
+ exit $?
+ ;;
+
+ esac
+fi
+
+# Set the docker run extra args (if any)
+FINAL_ARGS=${ARG_ARGS-${DOCKCROSS_ARGS}}
+
+# Bash on Ubuntu on Windows
+UBUNTU_ON_WINDOWS=$([ -e /proc/version ] && grep -l Microsoft /proc/version || echo "")
+# MSYS, Git Bash, etc.
+MSYS=$([ -e /proc/version ] && grep -l MINGW /proc/version || echo "")
+
+if [ -z "$UBUNTU_ON_WINDOWS" -a -z "$MSYS" ]; then
+ USER_IDS="-e BUILDER_UID=$( id -u ) -e BUILDER_GID=$( id -g ) -e BUILDER_USER=$( id -un ) -e BUILDER_GROUP=$( id -gn )"
+fi
+
+# Change the PWD when working in Docker on Windows
+if [ -n "$UBUNTU_ON_WINDOWS" ]; then
+ HOST_PWD=$PWD
+ HOST_PWD=${HOST_PWD/\/mnt\//}
+ HOST_PWD=${HOST_PWD/\//:\/}
+elif [ -n "$MSYS" ]; then
+ HOST_PWD=$PWD
+ HOST_PWD=${HOST_PWD/\//}
+ HOST_PWD=${HOST_PWD/\//:\/}
+else
+ HOST_PWD=$PWD
+fi
+
+#------------------------------------------------------------------------------
+# Now, finally, run the command in a container
+#
+tty -s && TTY_ARGS=-ti || TTY_ARGS=
+CONTAINER_NAME=dockcross_$RANDOM
+docker run $TTY_ARGS --name $CONTAINER_NAME \
+ -v "$HOST_PWD":/work \
+ $USER_IDS \
+ $FINAL_ARGS \
+ $FINAL_IMAGE "$@"
+run_exit_code=$?
+
+# Attempt to delete container
+rm_output=$(docker rm -f $CONTAINER_NAME 2>&1)
+rm_exit_code=$?
+if [[ $rm_exit_code != 0 ]]; then
+ if [[ "$CIRCLECI" == "true" ]] && [[ $rm_output == *"Driver btrfs failed to remove"* ]]; then
+ : # Ignore error because of https://circleci.com/docs/docker-btrfs-error/
+ else
+ echo "$rm_output"
+ exit $rm_exit_code
+ fi
+fi
+
+exit $run_exit_code
+
+################################################################################
+#
+# This image is not intended to be run manually.
+#
+# To create a dockcross helper script for the
+# dockcross/linux-armv7 image, run:
+#
+# docker run --rm dockcross/linux-armv7 > dockcross-linux-armv7
+# chmod +x dockcross-linux-armv7
+#
+# You may then wish to move the dockcross script to your PATH.
+#
+################################################################################
diff --git a/docker/development.Dockerfile b/docker/development.Dockerfile
new file mode 100644
index 00000000..d0f81329
--- /dev/null
+++ b/docker/development.Dockerfile
@@ -0,0 +1,4 @@
+FROM dockcross/linux-x64
+
+RUN apt-get update && apt-get install -y zlib1g-dev \
+ libuv0.10-dev