This is a collection of survey components. They can be combined into a survey via a config file. The app will take the user results and upload them.
Storybook stories have been created for each of the survey components. To view these stories, run
yarn install
yarn storybookA config file has been prepared which demonstrates available functionality. Feel free to use it as a starting point and edit it, or to start from scratch. All available options are used and described in the shipped config.yaml file.
The front-end supports the following environment variables. Some of them are mandatory!
| Variable Name | Required? | Example | Description |
|---|---|---|---|
| SOCKET_SERVER_URL | ✅ | http://localhost:3001 |
A URL pointing to a server running the socket server in the server directory. |
| CONFIG_YML_URL | ❌ | http://example.com/config.yml |
A URL pointing to a config file. If specified, the next build step will download the file and overwrite the current config.yaml. |
| LANGUAGES | ❌ | en-US, en-US,fr-FR |
A comma separated list of languages that are defined in the config. This list MUST overlap with the languages defined in the config, otherwise the build will fail. |
Run the development server:
npm run dev
# or
yarn devOpen http://localhost:3000 with your browser to see the result.
To see the localization support, append a language code at the end of the URL (for example, http://localhost:3000/fr will render French strings). The system will attempt to map that key to languages defined in the next.config.js. Language strings are stored in config.yaml.
A server component is included which is used as an intermediary between the front end and AWS S3, where the results are stored. The server operates with a continuous socket connect to the clients to ensure that all data entrered is captured, even if it isn't submitted. When the user disconnects, the data is uploaded to S3.
The server can be configured in server.config.json. Ensure that the AWS details are correctly filled out, and the port matches what is expected on the client.
To run the server in dev mode, run yarn server-dev.
To run the server in production mode, run yarn server.
yarn start will only serve what has been built by yarn build. For active development, yarn dev is recommended.