From 73361c6ecec0231232613d7d6c3a9ccf181020e1 Mon Sep 17 00:00:00 2001 From: Andrii Podanenko Date: Mon, 8 Nov 2021 13:07:38 +0200 Subject: [PATCH] docs: Introduce BUILD.md Addressing: https://github.com/ymcatwincities/openy_activity_finder/issues/67#issuecomment-963027345 Requested-by: @hamrant Initiated-by: @duozersk Fixed-by: @podarok --- BUILD.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..d3e24b5 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,30 @@ +Welcome to Activity Finder + +# How to build applications + +When you use source code of Activity Finder you need to follow steps of how to compile latest versions of javascript applications, included within. + + +## Internals + +Activity Finder contains three applications + +- Activity Finder v3 - folder /openy_af_vue_app +- Activity Finder v4 - folder /openy_af4_vue_app +- Camp Finder - folder /openy_cf_vue_app + +## Compillation + +In order to compile any of abobe three apps, follow steps below, please + +Go to respective folder + +Run in shell + +```sh +npm install +npm run build +``` + +After these are finished - you'd see in dist folders latest versions of compiled applications, which will be automatically used by Acitivity Finder on a site. +You would need to clear drupal and browser/cdn cache after obtaining new versions of compiled javascript files.