-
Notifications
You must be signed in to change notification settings - Fork 373
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update survey-creator-js README (#5800)
- Loading branch information
1 parent
360bfc3
commit 0190b4a
Showing
3 changed files
with
48 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,65 @@ | ||
| # SurveyJS UI (React+pReact internally) Form Library | ||
| # Survey Creator / Form Builder for HTML/CSS/JavaScript Applications | ||
|
|
||
| <video src="https://github.com/surveyjs/survey-creator/assets/22315929/884eeb5b-68e6-4d38-a8f9-d2483e6ce386"></video> | ||
|
|
||
| <video src="https://github.com/surveyjs/survey-library/assets/22315929/b24a68bf-d703-4096-835b-752f5f610aa6"></video> | ||
| [](https://dev.azure.com/SurveyJS/SurveyJS%20Integration%20Tests/_build/latest?definitionId=8&branchName=master) | ||
| <a href="https://www.npmjs.com/package/survey-creator"><img alt="NPM Version" src="https://img.shields.io/npm/v/survey-creator.svg" data-canonical-src="https://img.shields.io/npm/v/survey-creator.svg" style="max-width:100%;"></a> | ||
|
|
||
| A visual designer that enables you and your users to create and modify surveys and forms in your JavaScript application. | ||
|
|
||
| [](https://dev.azure.com/SurveyJS/SurveyJS%20Integration%20Tests/_build/latest?definitionId=7&branchName=master) | ||
| [](LICENSE) | ||
| <a href="https://github.com/DevExpress/testcafe"> | ||
| <img alt="Tested with TestCafe" src="https://img.shields.io/badge/tested%20with-TestCafe-2fa4cf.svg"> | ||
| </a> | ||
| <a href="https://github.com/surveyjs/survey-library/issues"> | ||
| <img alt="Issues" title="Open Issues" src="https://img.shields.io/github/issues/surveyjs/survey-library.svg"> | ||
| </a> | ||
| <a href="https://github.com/surveyjs/survey-library/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed+"> | ||
| <img alt="Closed issues" title="Closed Issues" src="https://img.shields.io/github/issues-closed/surveyjs/survey-library.svg"> | ||
| </a> | ||
| [Try Survey Creator / Form Builder](https://surveyjs.io/create-survey) | ||
|
|
||
| A free and open-source MIT-licensed JavaScript form builder library that allows you to design dynamic, data-driven, multi-language survey forms and run them in your vanilla JS applications. | ||
| This package is built upon [Preact](https://preactjs.com/) and is used to add Survey Creator to an application built with HTML, CSS, and JavaScript (without any frontend frameworks). You can also use this package to implement custom integration with any framework. Note that Survey Creator provides individual integration packages for Angular, React, and Vue: | ||
|
|
||
| ## Features | ||
|
|
||
| - Dynamic forms, surveys, polls, and quizzes for your JavaScript application | ||
| - Integration with React, Angular, Vue, jQuery, and Knockout | ||
| - 20+ built-in question types and support for custom question types | ||
| - Built-in themes and CSS customization | ||
| - Answer validation | ||
| - TypeScript support | ||
| - Community-supported UI localization to 50+ languages | ||
| - Integration with any backend framework (examples for PHP, NodeJS, and ASP.NET included) | ||
| - Compatibility with any server + database combination | ||
| - Third-party component integration | ||
| - [`survey-creator-react`](https://www.npmjs.com/package/survey-creator-react) | ||
| - [`survey-creator-angular`](https://www.npmjs.com/package/survey-creator-angular) | ||
| - [`survey-creator-vue`](https://www.npmjs.com/package/survey-creator-vue) | ||
|
|
||
| ## Get Started | ||
|
|
||
| To get started with SurveyJS UI Form Library, refer to the following tutorial: [Add a Survey to a jQuery Application](https://surveyjs.io/Documentation/Library?id=get-started-jquery). | ||
| To get started with Survey Creator / Form Builder for HTML/CSS/JavaScript applications, refer to the following tutorial: [Add Survey Creator / Form Builder to a JavaScript Application](https://surveyjs.io/survey-creator/documentation/get-started-html-css-javascript). | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Website](https://surveyjs.io/) | ||
| - [Documentation](https://surveyjs.io/Documentation/Library) | ||
| - [Live Examples](https://surveyjs.io/form-library/examples/nps-question/jquery) | ||
| - [Documentation](https://surveyjs.io/survey-creator/documentation/overview) | ||
| - [Live Examples](https://surveyjs.io/Examples/Survey-Creator) | ||
| - [What's New](https://surveyjs.io/WhatsNew) | ||
|
|
||
| ## Build SurveyJS UI Form Library from Sources | ||
| ## Build Survey Creator / Form Builder for React from Sources | ||
|
|
||
| If you want to build the library yourself, do the following: | ||
|
|
||
| 1. **Build `survey-library` and `survey-creator-core`**\ | ||
| Refer to the following instructions: | ||
|
|
||
| - [Build the SurveyJS Form Library from Sources](https://github.com/surveyjs/survey-library#build-the-surveyjs-form-library-from-sources) | ||
| - [Build the Survey Creator Model from Sources](https://github.com/surveyjs/survey-creator/tree/master/packages/survey-creator-core#build-the-survey-creator-model-from-sources) | ||
|
|
||
| > NOTE: Make sure that folders with cloned `survey-library` and `survey-creator` repositories are in the same directory. | ||
| 1. **Install build dependencies for Survey Creator / Form Builder for React** | ||
|
|
||
| ``` | ||
| cd survey-creator/packages/survey-creator-js | ||
| npm install | ||
| ``` | ||
|
|
||
| 1. **Build the library** | ||
|
|
||
| ``` | ||
| npm run build | ||
| ``` | ||
|
|
||
| You can find the built library in the "build" directory. | ||
|
|
||
| 1. **Run unit tests** | ||
|
|
||
| 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). | ||
| ``` | ||
| npm test | ||
| ``` | ||
| This command runs unit tests using [Karma](https://karma-runner.github.io/0.13/index.html). | ||
|
|
||
| ## Licensing | ||
|
|
||
| SurveyJS Form Library is distributed under the [MIT license](https://github.com/surveyjs/survey-library/blob/master/LICENSE). | ||
| Survey Creator is **not available for free commercial usage**. If you want to integrate it into your application, you must purchase a [commercial license](https://surveyjs.io/licensing). However, you can [use Survey Creator online](https://surveyjs.io/create-survey) to produce survey JSON configurations and run them with [SurveyJS Form Library](https://surveyjs.io/form-library/documentation/overview) in your application free of charge. |