https://github.com/roundtableAI/roundtable-js
Open-source research-grade programmatic survey software
https://github.com/roundtableAI/roundtable-js
behavioral forms javascript open-source research surveys
Last synced: 2 months ago
JSON representation
Open-source research-grade programmatic survey software
- Host: GitHub
- URL: https://github.com/roundtableAI/roundtable-js
- Owner: roundtableAI
- License: apache-2.0
- Created: 2024-06-30T23:22:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-30T18:27:11.000Z (about 1 year ago)
- Last Synced: 2024-11-09T15:18:44.290Z (11 months ago)
- Topics: behavioral, forms, javascript, open-source, research, surveys
- Language: JavaScript
- Homepage: https://surveys.roundtable.ai
- Size: 643 KB
- Stars: 258
- Watchers: 3
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
RoundtableJS
Programmatic survey software
Cloud editor •
Slack •
Documentation
RoundtableJS is an open-source JavaScript library for building complex surveys, forms, and data annotation tasks. It's designed to be simple but completely customizable. We make it easy to add complex logic (e.g. branching, skipping, looping), modify question types, and fully customize the design.
## 🌟 Features
- **Designed for the Modern Web:** We're designed in JavaScript and leverage its asynchronous functionality for managing survey logic. For example, rather than determining this logic based on callbacks that trigger when a page is submitted, our library builds the timeline in an async function which means the logic flows intuitively from top to bottom.
- **Developer-Friendly:** We are open-source and API-first. The idea for RoundtableJS arose by seeing how difficult it was to integrate Roundtable's API into other survey software. We want the open-source offering to include a robust plugin ecosystem where people can introduce new question types, integrate with tools like CRMs, and control how data is stored and processed.
- **AI-Native Functionality:** Our [cloud offering](https://surveys.roundtable.ai) has AI-native features such as natural language programming and automated fraud detection. We're continuously expanding our AI features. Let us know what tools you'd like to see!
## 🖼️ Examples
Here are some example surveys built with RoundtableJS. All code is in the [examples/studies](examples/studies) directory.
- [Element showcase](https://roundtable.ai/survey/3e76ab92512f398e366baffd772b06cf972c0c0e)
- [Enterprise market research survey](https://roundtable.ai/survey/3020c264e57a0415889a7d82330af66daf30db15)
- [Simple NPS with branding](https://roundtable.ai/survey/bed16082755fc02b70f582c1fe143b8e7d292a43)
- [Typeform survey](https://roundtable.ai/survey/134a2317bb595d7768194de65772f97dc760b60b)
- [Product market fit survey](https://roundtable.ai/survey/765c87578ccf7e24522e91c44cf41f845c4bcd0e)
- [Book a demo form](https://roundtable.ai/survey/374fd1f3f1719d69b21438cbacd7013d28b7daeb)
- [Data annotation task](https://roundtable.ai/survey/1518e8ae74e9075349b07ffeee8ee21166477e4d)
- [RLHF data collection](https://roundtable.ai/survey/89eeb07064400b58f2d3a3d979b0cff729f1ee2b)
## 🚀 Quick Start
## Installation
### Option 1: npm
1. Install roundtable-js using npm:
```bash
npm install roundtable-js
```
### Option 2: Git
1. Clone the repository:
```
git clone https://github.com/roundtableAI/roundtable-js.git
```
2. Navigate to the project directory:
```
cd roundtable-js
```
3. Include the necessary files in your project.
### Option 3: CDN
1. Include the following script tag in your HTML:
```html
```
## Usage
1. Import the necessary modules in your JavaScript file for npm or Git installations:
```javascript
import Survey from 'roundtable-js/core/survey.js';
import SingleSelect from 'roundtable-js/elements/singleSelect.js';
```
For CDN installation, ensure the script is loaded and use the global `RoundtableJS` object:
```javascript
const { Survey, SingleSelect } = RoundtableJS;
```
2. Create a survey instance and add pages with questions:
```javascript
// Define an asynchronous function to run the survey
async function runSurvey() {
// Create a new Survey instance with a specific participant ID
const survey = new Survey({ participantId: 'participant_123' });
// Define the first question as a single-select question with two options
const question1 = new SingleSelect({
id: 'question1',
text: 'A question',
options: ['Option 1', 'Option 2'],
});
// Define the second question as a single-select question with two options
const question2 = new SingleSelect({
id: 'question2',
text: 'A second question',
options: ['Option 1', 'Option 2'],
});
// Show the first page with the first question and wait for it to be answered
await survey.showPage({ id: 'page1', elements: [question1] });
// This code runs only after the first page is completed
console.log('Page 1 completed');
// Show the next page with the second question and wait for it to be answered
await survey.showPage({ id: 'page2', elements: [question2] });
// Finish the survey once all pages are completed and display an end message
survey.finishSurvey('Thank you for completing the survey!');
}
// Start the survey by calling the runSurvey function
runSurvey();
```
3. Set up your HTML:
```html
Survey
* {
box-sizing: border-box;
}
.hidden {
display: none;
}
Next
```
## 📚 Documentation
Read our [full documentation](https://docs.roundtable.ai/rjs/introduction).
## 🎉 Community
Join our community:
- [Slack](https://join.slack.com/t/roundtablejs/shared_invite/zt-2m09n74yv-B~UeGbxSzGMTO3f0qXhRxQ)
- [Twitter](https://twitter.com/roundtabledotai)
- [Blog](https://roundtable.ai/blog)
- [LinkedIn](https://www.linkedin.com/company/roundtable-ai)
## 🛠️ Development / Open-Source Community
Please see our [Contributing Guide](CONTRIBUTING.md).
## 📜 License
RoundtableJS is open source software [licensed](LICENSE).
---