-
Notifications
You must be signed in to change notification settings - Fork 0
Build deploy documentation
⚠️ Make sure to clone the repository with LF line ending applied when working on windows
-
Clone the repository via
git clone https://github.com/amosproj/amos-ss2021-project2-context-map.git
-
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. -
Install docker from https://docs.docker.com/get-docker/.
-
Install
yarn
by running
npm i -g yarn
- Make sure that docker is running.
- Navigate to the
/build
directory within the repository clone. - Run
node start-database
. A new docker container with the nameneo4j-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 commanddocker ps
in your terminal).
Run each of the scripts in the following order within a separate shell instance.
4. .\start-backend-dbg.ps1
5. .\start-frontend-dbg.ps1
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
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:
- 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 withLinux containers
. - Copy the content of the
artifacts
folder to the target machine. - Execute the
kmap
script to run the software on the target machine.
On linux machines, execute thekmap.sh
script, on windows machines thekmap.ps1
script.
A public demo of the project is available at http://5.183.20.2/.