From 7913d28cc2cadd1f9ae2c93ec4717923559281f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cato=20L=C3=A9an=20Tr=C3=BCtschel?= Date: Wed, 23 Jun 2021 09:57:17 +0200 Subject: [PATCH] Update readme on latest info on build and deployment --- README.md | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2d7c831b..65c6366f 100644 --- a/README.md +++ b/README.md @@ -18,28 +18,39 @@ This project was created as a university project and is part of the set of AMOS ## Current development Current development concentrates on creating a minimum viable product for KMAP. Core functionality will be integrating graph data bases, visualizing the graph data in a modular dashboard, and exploring the data with a no-code query builder. -## How to build -> :warning: **There is currently no common build system in place. Current development focuses on this issue, which is tracked by [#37](https://github.com/amosproj/amos-ss2021-project2-context-map/issues/37) and [#60](https://github.com/amosproj/amos-ss2021-project2-context-map/issues/60).** - +## How to start and deploy ### Prerequisites +> :warning: **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` +`git clone https://github.com/amosproj/amos-ss2021-project2-context-map.git` 1. Install node from [https://nodejs.org/en/](https://nodejs.org/en/). It is required to install node with version 12.x or higher. +1. Install docker as described in [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/). +If you are working with windows, make sure that docker is running with `Linux containers`. + 1. Install `yarn` by running `npm i -g yarn` -### Run the project -> :warning: **Scripts are currently only available for the windows platform or platforms that have powershell installed** - -To start the project, navigate to the `/build` directory within the repository clone and run each of the scripts in the following order within a separate shell instance. +### Start the project +To start the project, navigate to the `build` directory within the repository clone and run each of the commands in the following order. ``` -1. start-database.ps1 -2. start-backend-dbg.ps1 -3. start-frontend-dbg.ps1 +1. node start-database -d +2. node start-backend-detached +3. node start-frontend-detached ``` -## Releases -There are currently no stable releases of the project. +### Deploy the project +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/](https://docs.docker.com/get-docker/) +1. Copy the content of the `artifacts` folder to the target machine. +1. Execute the `kmap.sh` script to run the software on the target machine. +> :warning: **The `kmap` script is currently only available for linux target machines. There is currently no support for windows target machines. See [#340](https://github.com/amosproj/amos-ss2021-project2-context-map/issues/340)** + +## Demo +A public demo of the project is available at [http://5.183.20.2/](http://5.183.20.2/).