Skip to content

MetabolicSoftware/typeform-overview

Repository files navigation

Typeform overview

Typeform does not yet have a (exportable) overview of the full survey definition / content. To share the underlying logic people need to be granted edit rights. This projects takes in the json definitions of the surveys that can be downloaded through their API or their Request data function and generates a somewhat human readable overview. This overview could then also be saves as pdf. It hopefully provides an answer to this community question.

Project Setup

npm install

Loading survey definitions through API

Supply TYPEFORM_PERSONAL_ACCESS_TOKEN in an .env file, see .env.example.

npm run load-surveys

Compile and Hot-Reload for Development

npm run dev

Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint

ToDo's

  • Link fields and choices in logic the their fields and choices through anchors
  • Support more question types
  • Fix issues with *'s in texts

About

A somewhat human readable overview of a Typeform form based on a json export

Resources

License

Stars

Watchers

Forks

Packages

No packages published