Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add build instructions for survey-angular-ui and survey-vue3-ui #7304

Merged
merged 2 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
RomanTsukanov marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions build-scripts/survey-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-jquery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
5 changes: 5 additions & 0 deletions build-scripts/survey-knockout-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-knockout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-react-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-vue-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 4 additions & 0 deletions build-scripts/survey-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
53 changes: 53 additions & 0 deletions packages/survey-angular-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
50 changes: 50 additions & 0 deletions packages/survey-vue3-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/.
RomanTsukanov marked this conversation as resolved.
Show resolved Hide resolved

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).