From 0df22462046f172dcbe9f185406ae2bfa4e6bfe2 Mon Sep 17 00:00:00 2001 From: RomanTsukanov Date: Tue, 7 Nov 2023 19:21:01 +0400 Subject: [PATCH 1/2] Add build instructions for survey-angular-ui and survey-vue3-ui (cherry picked from commit 669f67f4b469500ad2b5eaf11b978c5749c8ba61) --- README.md | 2 +- build-scripts/survey-angular/README.md | 4 ++ build-scripts/survey-core/README.md | 4 ++ build-scripts/survey-jquery/README.md | 4 ++ build-scripts/survey-knockout-ui/README.md | 5 ++ build-scripts/survey-knockout/README.md | 4 ++ build-scripts/survey-react-ui/README.md | 4 ++ build-scripts/survey-react/README.md | 4 ++ build-scripts/survey-vue-ui/README.md | 4 ++ build-scripts/survey-vue/README.md | 4 ++ packages/survey-angular-ui/README.md | 53 ++++++++++++++++++++++ packages/survey-vue3-ui/README.md | 50 ++++++++++++++++++++ 12 files changed, 141 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bf7a4ce992..eadf85762c 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ A free and open-source MIT-licensed JavaScript form builder library that allows ``` 1. **Install dependencies** -Make sure that you have Node.js v6.0.0 or later and npm v2.7.0 or later installed. +Make sure that you have Node.js v14 or later and a compatible npm version installed. ```cmd npm install -g karma-cli diff --git a/build-scripts/survey-angular/README.md b/build-scripts/survey-angular/README.md index b18e315a6a..acc69653c4 100644 --- a/build-scripts/survey-angular/README.md +++ b/build-scripts/survey-angular/README.md @@ -17,6 +17,10 @@ SurveyJS Form Library is a free and open-source MIT-licensed JavaScript form bui - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/angular) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Form Library for Angular from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/build-scripts/survey-core/README.md b/build-scripts/survey-core/README.md index a3c073a989..f825b7353b 100644 --- a/build-scripts/survey-core/README.md +++ b/build-scripts/survey-core/README.md @@ -27,6 +27,10 @@ A platform-independent survey model for SurveyJS Form Library. This package shou - [Live Examples](https://surveyjs.io/Examples/Library) - [What's New](https://surveyjs.io/WhatsNew) +## Build Survey Model from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). diff --git a/build-scripts/survey-jquery/README.md b/build-scripts/survey-jquery/README.md index d4c4e943a0..2974956629 100644 --- a/build-scripts/survey-jquery/README.md +++ b/build-scripts/survey-jquery/README.md @@ -38,6 +38,10 @@ To get started with SurveyJS jQuery Form Library, refer to the following tutoria - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/jquery) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS jQuery Form Library from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). diff --git a/build-scripts/survey-knockout-ui/README.md b/build-scripts/survey-knockout-ui/README.md index 1b289ce56f..80fdeb30eb 100644 --- a/build-scripts/survey-knockout-ui/README.md +++ b/build-scripts/survey-knockout-ui/README.md @@ -38,6 +38,11 @@ To get started with SurveyJS Knockout Form Library, refer to the following tutor - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/knockoutjs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Knockout Form Library from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/build-scripts/survey-knockout/README.md b/build-scripts/survey-knockout/README.md index 5a02a8f840..1cf46e1664 100644 --- a/build-scripts/survey-knockout/README.md +++ b/build-scripts/survey-knockout/README.md @@ -11,6 +11,10 @@ SurveyJS Form Library is a free and open-source MIT-licensed JavaScript form bui - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/knockoutjs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Form Library for Knockout from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/build-scripts/survey-react-ui/README.md b/build-scripts/survey-react-ui/README.md index aef4eb0fb7..1b36e43348 100644 --- a/build-scripts/survey-react-ui/README.md +++ b/build-scripts/survey-react-ui/README.md @@ -38,6 +38,10 @@ To get started with SurveyJS React Form Library, refer to the following tutorial - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/reactjs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS React Form Library from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/build-scripts/survey-react/README.md b/build-scripts/survey-react/README.md index 21268dea3e..eb651b201b 100644 --- a/build-scripts/survey-react/README.md +++ b/build-scripts/survey-react/README.md @@ -11,6 +11,10 @@ SurveyJS Form Library is a free and open-source MIT-licensed JavaScript form bui - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/reactjs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Form Library for React from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/build-scripts/survey-vue-ui/README.md b/build-scripts/survey-vue-ui/README.md index a1f729d347..cc0209af05 100644 --- a/build-scripts/survey-vue-ui/README.md +++ b/build-scripts/survey-vue-ui/README.md @@ -40,6 +40,10 @@ To get started with SurveyJS Vue Form Library, refer to the following tutorial: - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/vuejs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Vue Form Library from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/build-scripts/survey-vue/README.md b/build-scripts/survey-vue/README.md index 496556b138..cbb79dbdc9 100644 --- a/build-scripts/survey-vue/README.md +++ b/build-scripts/survey-vue/README.md @@ -11,6 +11,10 @@ SurveyJS Form Library is a free and open-source MIT-licensed JavaScript form bui - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/vuejs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Form Library for Vue from Sources + +Refer to instructions in the root README file: [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/packages/survey-angular-ui/README.md b/packages/survey-angular-ui/README.md index adedb44d23..c508fe4d8e 100644 --- a/packages/survey-angular-ui/README.md +++ b/packages/survey-angular-ui/README.md @@ -50,6 +50,59 @@ To get started with SurveyJS Angular Form Library, refer to the following tutori - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/angular) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Angular Form Library from Sources + +1. **Clone the repo** + + ```cmd + git clone https://github.com/surveyjs/survey-library.git + cd survey-library + ``` + +1. **Install dependencies common for all SurveyJS libraries** +Make sure that you have Node.js v14 or later and a compatible npm version installed. + + ```cmd + npm install -g karma-cli + npm install + ``` + +1. **Build the [platform-independent part](https://github.com/surveyjs/survey-library/blob/master/build-scripts/survey-core/README.md#survey-model-platform-independent-part) and plugins** + + ``` + npm run build_core + npm run build-plugins + ``` + +1. **Install SurveyJS Angular Form Library dependencies and build this library** + + ``` + cd packages/survey-angular-ui + npm i + npm run build + ``` + + You can find the built scripts and style sheets in folders under the `build` directory. + +1. **Run a test application** + + ``` + cd example + npm i + cd packages/survey-angular-ui + npm run serve:example + ``` + + This command runs a local HTTP server at http://localhost:4200/. + +1. **Run unit tests** + + ``` + npm run test + ``` + + The unit tests use [Karma](https://karma-runner.github.io/6.3/index.html). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file diff --git a/packages/survey-vue3-ui/README.md b/packages/survey-vue3-ui/README.md index 568db603d4..970b6bb05a 100644 --- a/packages/survey-vue3-ui/README.md +++ b/packages/survey-vue3-ui/README.md @@ -40,6 +40,56 @@ To get started with SurveyJS Vue Form Library, refer to the following tutorial: - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/vuejs) - [What's New](https://surveyjs.io/WhatsNew) +## Build SurveyJS Vue Form Library from Sources + +1. **Clone the repo** + + ```cmd + git clone https://github.com/surveyjs/survey-library.git + cd survey-library + ``` + +1. **Install dependencies common for all SurveyJS libraries** +Make sure that you have Node.js v16 or later and a compatible npm version installed. + + ```cmd + npm install -g karma-cli + npm install + ``` + +1. **Build the [platform-independent part](https://github.com/surveyjs/survey-library/blob/master/build-scripts/survey-core/README.md#survey-model-platform-independent-part) and plugins** + + ``` + npm run build_core + npm run build-plugins + ``` + +1. **Install SurveyJS Vue Form Library dependencies and build this library** + + ``` + cd packages/survey-vue3-ui + npm i + npm run build + ``` + + You can find the built scripts and style sheets in folders under the `build` directory. + +1. **Run a test application** + + ``` + npm run dev + ``` + + This command runs a local HTTP server at http://localhost:4200/. + +2. **Run unit tests** + + ``` + npm run test + ``` + + The unit tests use [Karma](https://karma-runner.github.io/6.3/index.html). + ## Licensing SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). \ No newline at end of file From d8db4199e2dbfdb6e7ca9fea6aab524d4d1b40f5 Mon Sep 17 00:00:00 2001 From: RomanTsukanov Date: Wed, 8 Nov 2023 11:22:31 +0400 Subject: [PATCH 2/2] Add backlinks and fix the port for Vue 3 --- README.md | 2 ++ packages/survey-vue3-ui/README.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eadf85762c..be190bdfff 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ A free and open-source MIT-licensed JavaScript form builder library that allows ## Build the SurveyJS Form Library from Sources +> The instructions below apply to SurveyJS Form Library for React, Knockout, jQuery, and Vue 2. If you are looking for instructions on how to build the library for Angular or Vue 3, refer to README files within the [`survey-angular-ui`](packages/survey-angular-ui/README.md#build-surveyjs-angular-form-library-from-sources) or [`survey-vue3-ui`](packages/survey-vue3-ui/README.md#build-surveyjs-vue-form-library-from-sources) packages. + 1. **Clone the repo** ```cmd diff --git a/packages/survey-vue3-ui/README.md b/packages/survey-vue3-ui/README.md index 970b6bb05a..80525cb88d 100644 --- a/packages/survey-vue3-ui/README.md +++ b/packages/survey-vue3-ui/README.md @@ -80,7 +80,7 @@ Make sure that you have Node.js v16 or later and a compatible npm version instal npm run dev ``` - This command runs a local HTTP server at http://localhost:4200/. + This command runs a local HTTP server at http://localhost:5173/. 2. **Run unit tests**