Skip to content

Build deploy documentation

Jump to bottom
Tobias Kopyto edited this page Jul 8, 2021 · 10 revisions

Build and deploy documentation

How to build

Prerequisites

⚠️ Make sure to clone the repository with LF line ending applied when working on windows

  1. Clone the repository via
    git clone https://github.com/amosproj/amos-ss2021-project2-context-map.git

  2. Install node from https://nodejs.org/en/ and make sure to add your installation directory to PATH.
    It is required to install node with version 12.x or higher.

  3. Install docker from https://docs.docker.com/get-docker/.

  4. Install yarn by running
    npm i -g yarn

Run the project

  1. Make sure that docker is running.
  2. Navigate to the /build directory within the repository clone.
  3. Run node start-database. A new docker container with the name neo4j-db should run now. If it is only created, but does not run, run the container (you can check if the container is running with the command docker ps in your terminal).

Windows and platforms with powershell installed

Run each of the scripts in the following order within a separate shell instance.

4. .\start-backend-dbg.ps1 
5. .\start-frontend-dbg.ps1

Linux and Mac

Run each of the scripts in the following order.

4. ./start-backend-dbg.sh & 
5. ./start-frontend-dbg.sh &

Once database, backend and frontend were built for one time, the backend and frontend can also be started by running

[4.] node start-backend-detached
[5.] node start-frontend-detached

How to deploy

To deploy the project execute the deploy script in the repository root directory after cloning.
When working on windows, execute the deploy.ps1 script, on linux and MacOs, run the deploy.sh script.
The deployment artifacts are copied to the artifacts folder in the repository root.

To execute the deployment artifacts on the target machine follow tese steps:

  1. Make sure that docker is installed on the target machine. If not, install it as described in https://docs.docker.com/get-docker/
    If the target machine runs with windows, make sure that docker is running with Linux containers.
  2. Copy the content of the artifacts folder to the target machine.
  3. Execute the kmap script to run the software on the target machine.
    On linux machines, execute the kmap.sh script, on windows machines the kmap.ps1 script.

Demo

A public demo of the project is available at http://5.183.20.2/.

Clone this wiki locally