stur86
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm install
+    - run: npm run build --if-present
+    - run: npm test
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,23 @@
+FROM node:16-alpine as base
+
+FROM base as prod
+
+WORKDIR /app
+COPY package*.json .
+RUN npm install
+COPY . .
+
+# -- either --- #
+# use npm start a developement server (slower to start up, but quicker to build the docker image...)
+EXPOSE 3000
+CMD ["npm", "start"]
+
+
+# -- or --- #
+# # or build optimised version of app and serve that
+# #  (this takes about 90s on my machine)
+# RUN npm run build
+# RUN npm install -g serve
+
+# EXPOSE 3000
+# CMD ["serve", "-s", "build"]
diff --git a/README.md b/README.md
@@ -1,6 +1,24 @@
 # magresview-2
 MagresView 2.0 - NMR crystallography visualisation app
 
+### Running a local copy
+
+If you want to run MagresView 2.0 (offline) on your local machine, you need to get the `gh-pages` branch of the code as this contains the pre-built app. 
+
+You can get the current version here:
+
+https://github.com/CCP-NC/magresview-2/archive/refs/heads/gh-pages.zip
+
+Once downloaded, you no longer need an internet connection. You simply unzip the file, which will create a directory called `magresview-2-gh-pages`; in that you'll find an `index.html` file. Opening this in the browser of your choice starts the app. 
+
+**Alternatively**, if you prefer, you can instead use [git](https://github.com/git-guides/install-git) to download the `gh-pages` branch:
+
+`git clone -b gh-pages https://github.com/CCP-NC/magresview-2.git`
+
+This will create a directory called `magresview-2` within which you'll find the `index.html` file.
+
+
+
 ### Developers
 
-Check out `docs/DevArchitecture.md` for an explanation of the structure of the software and conventions to adopt.
+Check out `docs/DevArchitecture.md` for an explanation of the structure of the software and conventions to adopt.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,15 @@
+version: '3.9'
+services:
+  app:
+    build:
+      context: "./"
+      target: "base"
+    command: sh -c "npm install && npm start"
+    environment:
+        - NODE_ENV=development
+        - PORT=3000
+    ports:
+        - "3000:3000"
+    working_dir: /app
+    volumes:
+        - .:/app