Merge pull request #12 from DealerDotCom/feature/local_build

Setting up a dockerized local env

Author: DanMat

.gitignore

@@ -22,3 +22,4 @@ build/
 _yardoc
 doc/
 .idea/
+source/index.html.md

CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+
+- Added ability to run project locally via a dockerized container.
 
 ## [v2021-05-21T19.31.40] - 2021-05-21
 

local/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:2.7-alpine
+
+COPY build-local-doc.sh /usr/bin/
+
+RUN apk --no-cache --update add nodejs g++ make coreutils git && \
+    git clone https://github.com/slatedocs/slate.git /slate && cd slate \
+    && echo 'gem "middleman-livereload", "~> 3.4.3"' >> Gemfile \
+    && echo 'activate :livereload' >> config.rb \
+    && bundle install \
+    && chmod +x /usr/bin/*.sh
+
+WORKDIR /slate
+
+EXPOSE 4567
+
+ENTRYPOINT ["sh", "/usr/bin/build-local-doc.sh"]

local/README.md

@@ -0,0 +1,25 @@
+# Local Setup
+
+We use a dockerized ruby environment to build and watch your local changes.
+
+## Building your docker
+
+Run the following command in this directory to set up the docker container
+
+```docker build -t wiapi-doc .```
+
+## Run your docker container 
+
+Run the following command in this directory to build and watch the external document
+
+```docker run --rm -v ${PWD%/*}/source:/slate/source -p 4567:4567 -it wiapi-doc external```
+
+Run the following command in this directory to build and watch the internal document
+
+```docker run --rm -v ${PWD%/*}/source:/slate/source -p 4567:4567 -it wiapi-doc internal```
+
+## View the document in your local
+
+The document would be available in [http://localhost:4567](http://localhost:4567). 
+
+Once, you have  your docker container running.

local/build-local-doc.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+function cleanup {
+  echo "Removing the generated index.html.md file"
+  rm source/index.html.md
+}
+
+trap cleanup EXIT
+
+echo "Deleting old 'build' folder if exists ..."
+rm -rf source/build
+
+echo "Generating a index.html.md file for the $1 doc..."
+if [ $1 = "external" ]; then 
+    cp source/index.html.external.md source/index.html.md
+elif [ $1 = "internal" ]; then
+    cp source/index.html.internal.md source/index.html.md
+else 
+	echo "Unknown argument '$1', will do nothing and exit"
+	echo "Accepted arguments: external, internal"
+fi
+
+echo "Building static html doc to 'build' folder ..."
+bundle exec middleman build --clean
+
+echo "Copying result into 'build' folder ..."
+cp -r build source/
+
+echo "Serving live doc at http://127.0.0.1:4567 ..."
+bundle exec middleman server