{"id":13397921,"url":"https://github.com/tellform/tellform","last_synced_at":"2025-09-27T10:31:30.312Z","repository":{"id":34375360,"uuid":"38300942","full_name":"tellform/tellform","owner":"tellform","description":"✏️ Free Opensource Alternative to TypeForm or Google Forms ⛺","archived":true,"fork":false,"pushed_at":"2019-10-09T13:58:17.000Z","size":22489,"stargazers_count":3029,"open_issues_count":70,"forks_count":531,"subscribers_count":100,"default_branch":"master","last_synced_at":"2024-08-05T21:25:17.184Z","etag":null,"topics":["form-builder","forms","google-forms","mean-stack","nodejs","self-hosted","typeform"],"latest_commit_sha":null,"homepage":"https://tellform.com/","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tellform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-30T09:42:24.000Z","updated_at":"2024-08-01T09:55:27.000Z","dependencies_parsed_at":"2022-07-13T09:10:34.392Z","dependency_job_id":null,"html_url":"https://github.com/tellform/tellform","commit_stats":null,"previous_names":["whitef0x0/tellform"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tellform%2Ftellform","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tellform%2Ftellform/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tellform%2Ftellform/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tellform%2Ftellform/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tellform","download_url":"https://codeload.github.com/tellform/tellform/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219856621,"owners_count":16553548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["form-builder","forms","google-forms","mean-stack","nodejs","self-hosted","typeform"],"created_at":"2024-07-30T18:01:53.302Z","updated_at":"2025-09-27T10:31:24.582Z","avatar_url":"https://github.com/tellform.png","language":"JavaScript","funding_links":["https://opencollective.com/tellform","https://opencollective.com/tellform).--","https://opencollective.com/elliot","https://opencollective.com/proxy/images/?src=https%3A%2F%2Fd1ts43dypk8bqh.cloudfront.net%2Fv1%2Favatars%2F6fd61b2c-62b6-438a-9168-bab7ef1489b8","https://opencollective.com/aldrnv"],"categories":["JavaScript","nodejs","Tools"],"sub_categories":["WebTools"],"readme":"TellForm 2.1.0\n========\n\nDEPRECATION WARNING UNTIL FURTHER NOTICE.\nThere are many oudated and vulnerable dependencies within this project and I recommend that you use this code repository for internal testing and development only.\n\nThere were too many impassable hurdles to really continue forward at the pace that I was hoping with TellForm @leopere~ If you want to follow my progress on an alternative in the mean time check out https://OhMyForm.com or our Discord server.  We managed to get the base Docker image fixed before forking the code so you can give this a try however not much has changed at the moment.\n\u003c!--\n[![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/)\n[![Build Status](https://travis-ci.org/tellform/tellform.svg?branch=master)](https://travis-ci.org/tellform/tellform)\n![Project Status](https://img.shields.io/badge/status-2.1.0-green.svg)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3491e86eb7194308b8fc80711d736ede)](https://www.codacy.com/app/david-baldwin/tellform?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=tellform/tellform\u0026amp;utm_campaign=Badge_Grade)\n--\u003e\n\nTo Join the fork's community please follow this Discord button here.\n\n![Discord](https://img.shields.io/discord/595773457862492190.svg?label=Discord%20Chat)\n\n## Readme and Issues\nThe README.md is still effectively in tact however it's all been commented out so that it's no longer visible on the main github repository page.  You may visit it by navigating through the repositories files themselves.  \n\nNo new or old issues will be tended to so the Issues Board has been closed.  We don't recommend using this repositories codebase as its no longer maintained and is only intended for reference code.  If you wish to use the fork which should remain backwards compatible feel free to explore [https://ohmyform.com](https://ohmyform.com/) or its GitHub repository at [https://github.com/ohmyform/ohmyform/](https://github.com/ohmyform/ohmyform/) where the code base is started from TellForm we are planning on keeping it reverse compatible however the code is Sublicensed AGPL and is going to have a stable release prepared for the public hopefully but September 12th 2019.  It should be a drop in replacement for TellForm which should expand on the vision of TellForm but hopefully bring it all up to date.  \n\n\u003c!--\n\u003e An *opensource alternative to TypeForm* that can create [stunning mobile-ready forms](https://tellform.com/examples) , surveys and questionnaires.--\u003e\n\n\u003c!--\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/tellform/tellform/tree/master)\n--\u003e\n\u003c!--\n## Table of Contents  \n- [Features](#features)\n- [How to Contribute](#how-to-contribute)\n- [Quickstart](#quickstart)\n- [Deploying with Docker](#deploying-with-docker)\n- [Testing your Application](#testing-your-application)\n- [Advanced Configuration](#configuration)\n- [Where to Get Help](#where-to-get-help)\n- [Sponsors](#sponsors)\n- [Backers](#backers)\n- [Contributors](#contributors)\n- [Mentions on the Web](#mentions-on-the-web)\n## Features\n### Currently following features are implemented:\n- Multi-Language Support\n- 11 possible question types\n- Editable start and end pages\n- Export Submissions to XLS, JSON or CSV\n- Native Analytics and Google Analytics Support\n- Custom Subdomains for each User\n- Embeddable Forms\n- Forms as a Service API\n- Deployable with Heroku and DockerHub\n### On the Roadmap for v3.0.0\n- Implement encryption for all form data\n- Add Typeform API integration\n- Add plugin/3rd party integration support (ala Slack)\n- Create wiki for easy installation and setup\n- Add Stripe/Payment Form field\n- Add Custom Background and Dropdown Field Images\n- Add File Upload Form Field\n## How to Contribute\nPlease checkout our CONTRIBUTING.md on ways to contribute to TellForm.\nAll contributors are eligible to get a free [TellForm Sticker](https://www.stickermule.com/marketplace/15987-tellform-round-sticker). All you have to do is submit a PR, get it accepted, email your address to team [at] tellform.com and we'll send you a sticker that you can proudly put on your laptop.\n## Quickstart\nBefore you start, make sure you have\n1. [Redis](https://redis.io/) installed and running at 127.0.0.1:6379\n2. [MongoDB](https://www.mongodb.com/) installed and running at 127.0.0.1:27017 (OR specify the host and port in config/env/all)\nAlso make sure to install [DNS Masq](http://www.thekelleys.org.uk/dnsmasq/doc.html) or equivalent if running it locally on your computer (look at dns_masq_setup_osx for instructions on OSX)\nInstall dependencies first.\n```bash\n$ npm install\n$ bower install\n```\nSetup environment.\n```bash\n$ grunt build\n```\nCreate your user account\n```bash\n$ node ./scripts/setup.js\n```\nOR create your .env file\n```\nGOOGLE_ANALYTICS_ID=yourGAID\nPRERENDER_TOKEN=yourPrerender.ioToken\nCOVERALLS_REPO_TOKEN=yourCoveralls.ioToken\nBASE_URL=localhost\nDSN_KEY=yourPrivateRavenKey\n# Mail config\nMAILER_EMAIL_ID=user@domain.com\nMAILER_PASSWORD=some-pass\nMAILER_FROM=user@domain.com\n# Use this for one of Nodemailer's pre-configured service providers\nMAILER_SERVICE_PROVIDER=SendGrid\n# Use these for a custom service provider\n# Note: MAILER_SMTP_HOST will override MAILER_SERVICE_PROVIDER\nMAILER_SMTP_HOST=smtp.domain.com\nMAILER_SMTP_PORT=465\nMAILER_SMTP_SECURE=TRUE\n```\nSide note: ___Currently we are using Raven and Sentry [https://www.getsentry.com](https://www.getsentry.com) for error logging. To use it you must provide a valid private DSN key in your .env file and a public DSN key in app/views/layout.index.html___\n#### To run the development version:\nSet ```NODE_ENV=development``` in .env file\n```$ grunt```\n#### To run the production version:\nSet ```NODE_ENV=production``` in .env file\n```$ grunt```\nYour application should run on port 3000 or the port you specified in your .env file, so in your browser just go to [http://localhost:3000](http://localhost:3000)\n## Deploying with Docker\nTo deploy with docker, first install docker [here](https://docs.docker.com/engine/installation/).\nThen run follow these steps:\n### Step 1: Clone the repo\n`$ git clone https://github.com/tellform/docker_files.git`\n### Step 2: Setup TellForm Configuration\nCreate your .env file by copying the .env.dist file included in the repo and changing it to suit your deployment.\nImportant: You need to fill out all of the ENV variables in the \"Mail Settings\" section or your TellForm instance won't work.\nIf you want to have https, make sure to change 'TLS_FLAVOR'\n### Step 3: Start your TellForm instance\n`docker-compose up -d`\nTellForm should now be accessible on http://localhost\n## Testing Your Application\nYou can run the full test suite included with TellForm with the test task:\n```\n$ grunt test\n```\nThis will run both the server-side tests (located in the app/tests/ directory) and the client-side tests (located in the public/modules/*/tests/).\nTo execute only the server tests, run the test:server task:\n```\n$ grunt test:server\n```\nAnd to run only the client tests, run the test:client task:\n```\n$ grunt test:client\n```\nCurrently the live example uses heroku github deployments. The Docker file is out of date and does not work. If someone wishes to get it working feel free to submit a pull request.\nTo calculate your total test coverage with Istanbul, run the coverage task\n```bash\n$ grunt coverage\n```\nTo calculate your server-side test coverage with Istanbul, run the coverage task\n```bash\n$ grunt coverage:server\n```\nTo calculate your client-side test coverage with Istanbul, run the coverage task\n```bash\n$ grunt coverage:client\n```\n## Configuration\nTellForm's configuration is done with environment variables. To set an option for TellForm, open/create your .env file and set add `ENV_VAR=somevalue` to set the ENV_VAR variable to the value `somevalue`.\n| Property                | Valid Values                                           | Default Value                                                        | Description                                                                                                           | Required?                                  |\n|-------------------------|--------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------|\n| NODE_ENV                | \"development\", \"production\", \"test\" or \"secure\"        | development                                                          | Set which version of the app you want to run  (either secure/SSL, dev, prod or test)                                  | No                                         |\n| SESSION_SECRET          | Any string                                             | CHANGE_ME_PLEASE                                                     | Value used to compute session hash                                                                                    | No                                         |\n| BASE_URL                | A valid URL                                            | localhost:3000                                                       | URL where the admin panel will live                                                                                   | Yes                                        |\n| MONGODB_URI             | A valid MongoDB URI                                    | localhost/mean                                                       | URI of the MONGODB server/db that your server will use                                                                | Yes                                        |\n| REDIS_URL               | A valid Redis URI                                      | redis://127.0.0.1:6379                                               | URI of the Redis instance that your server will use                                                                   | Only if ENABLE_CLUSTER_MODE=TRUE           |\n| SOCKET_PORT             | A valid port number from 0 - 65535                     | 20523                                                                | Port that your SocketIO server will bind to                                                                           | No                                         |\n| SOCKET_URL              | A valid URL                                            | ws.tellform.com                                                      | Url that your SocketIO server will bind to                                                                            | No                                         |\n| SIGNUP_DISABLED         | \"TRUE\" or \"FALSE\"                                      | FALSE                                                                | Set this flag to disable signups.                                                                                     | No                                         |\n| SUBDOMAINS_DISABLED     | \"TRUE\" or \"FALSE\"                                      | FALSE                                                                | Set this flag to disable subdomains. (Useful if hosting behind an uncontrolled domain or without a wildcard SSL cert) | No                                         |\n| ENABLE_CLUSTER_MODE     |  \"TRUE\" or \"FALSE\"                                     | FALSE                                                                | Disable support for running TellForm with pm2's cluster mode. Disabling this allows you to not run a Redis instance.  | No                                         |\n| MAILER_EMAIL_ID         | A string                                               | N/A                                                                  | Username credential for the SMTP MAIL service used to send signup/verification/lost password emails.                  | Yes                                        |\n| MAILER_PASSWORD         | A string                                               |                                                                      | Password credential for the SMTP MAIL service used to send signup/verification/lost password emails.                  | Yes                                        |\n| MAILER_FROM             | A valid email                                          | noreply@tellform.com                                                 | Email address that all mail should be sent from.                                                                      | No                                         |\n| MAILER_SERVICE_PROVIDER | A service from https://nodemailer.com/smtp/well-known/ |                                                                      | A \"well-known\" email service that is supported by nodemail. If MAILER_SMTP_HOST is enabled, this is ignored.          | Only if MAILER_SMTP_HOST is not set        |\n| MAILER_SMTP_HOST        | A valid URL                                            |                                                                      | URL to the SMTP server of your choice                                                                                 | Only if MAILER_SERVICE_PROVIDER is not set |\n| MAILER_SMTP_PORT        | A valid port number from 0 - 65535                     |                                                                      | Port of the SMTP server of your choice.                                                                               | Only if MAILER_SMTP_HOST is set            |\n| MAILER_SMTP_SECURE      | \"TRUE\" or \"FALSE\"                                      | FALSE                                                                | Boolean that enables/disables SSL support for your SMTP client.                                                       | Only if MAILER_SMTP_HOST is set            |\n| CREATE_ADMIN            | \"TRUE\" or \"FALSE\"                                      | FALSE                                                                | Setting this variable will create a admin user on startup with credentials as specified below                         | No                                         |\n| ADMIN_EMAIL             | A valid email                                          | admin@admin.com                                                      | Email of generated admin user                                                                                         | No                                         |\n| ADMIN_USERNAME          | A string                                               | root                                                                 | Username of generated admin user                                                                                      | No                                         |\n| ADMIN_PASSWORD          | A string                                               | root                                                                 | Password of generated admin user                                                                                      | No                                         |\n| APP_NAME                | A string                                               | TellForm                                                             | Sets the \u003ctitle\u003e property of your webapp.                                                                             | No                                         |\n| APP_DESC                | A string                                               | Opensource form builder alternative to TypeForm                      | Sets the,property of your webapp.                                                                                     | No                                         |\n| APP_KEYWORDS            | A comma-seperated list of phrases/words                | typeform, pdfs, forms, opensource, formbuilder, google forms, nodejs | Sets the value of the \u003cmeta\u003e description attribute.                                                                   | No                                         |\n| RAVEN_DSN               | A valid Sentry.io DSN                                  | N/A                                                                  | Set this to your Sentry.io Public DSN to enable remote logging                                                        | No                                         |\n| GOOGLE_ANALYTICS_ID     | A valid Google Analytics ID                            | N/A                                                                  | Set this to your GA id to enable GA tracking on your TellForm instance                                                | No                                         |\n## Where to get help\n[Gitter Chat](https://gitter.im/tellform/Lobby)\n[Official Twitter](https://twitter.com/tellform_real)\n--\u003e\n\n\n## Sponsors\n\nFurther Sponsorships are no longer accepted.\n\u003c!--\nDoes your company use TellForm? Help keep the project bug-free and feature rich by [sponsoring the project](https://opencollective.com/tellform#sponsor).\n\u003ca href=\"https://countable.ca\" style=\"padding: 30px 0\"\u003e\n\t\u003cimg src=\"https://countable.ca/logo.cb446ab0.svg\" height=\"30px\"\u003e\n\u003c/a\u003e --\u003e\n\n## Backers\n\nLove our work and community? \u003c!--[Become a backer](https://opencollective.com/tellform).--\u003e\n\n\u003ca href=\"https://opencollective.com/elliot\" target=\"_blank\"\u003e\n\t\u003cimg src=\"https://opencollective.com/proxy/images/?src=https%3A%2F%2Fd1ts43dypk8bqh.cloudfront.net%2Fv1%2Favatars%2F6fd61b2c-62b6-438a-9168-bab7ef1489b8\" height= \"64\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://opencollective.com/aldrnv\" target=\"_blank\"\u003e\n\t\u003cimg src=\"https://opencollective.com/public/images/users/avatar-01.svg\" height=\"64\"\u003e\n\u003c/a\u003e\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n| [\u003cimg src=\"https://avatars2.githubusercontent.com/u/1160417?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eDavid Baldwynn\u003c/sub\u003e](http://baldwynn.me)\u003cbr /\u003e[💻](https://github.com/tellform/tellform/commits?author=whitef0x0 \"Code\") [🔧](#tool-whitef0x0 \"Tools\") [🚇](#infra-whitef0x0 \"Infrastructure (Hosting, Build-Tools, etc)\") [📖](https://github.com/tellform/tellform/commits?author=whitef0x0 \"Documentation\") [💡](#example-whitef0x0 \"Examples\") [🎨](#design-whitef0x0 \"Design\") [🔍](#fundingFinding-whitef0x0 \"Funding Finding\") [👀](#review-whitef0x0 \"Reviewed Pull Requests\") [⚠️](https://github.com/tellform/tellform/commits?author=whitef0x0 \"Tests\") | [\u003cimg src=\"https://avatars2.githubusercontent.com/u/313117?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eSamuel Laulhau\u003c/sub\u003e](https://samuellaulhau.fr)\u003cbr /\u003e[💻](https://github.com/tellform/tellform/commits?author=lalop \"Code\") [🌍](#translation-lalop \"Translation\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/313507?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eArun Pattnaik\u003c/sub\u003e](http://arun.co)\u003cbr /\u003e[🎨](#design-arunpattnaik \"Design\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/5405744?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eThiên Toán\u003c/sub\u003e](https://toanalien.com)\u003cbr /\u003e[🐛](https://github.com/tellform/tellform/issues?q=author%3Atoanalien \"Bug reports\") [💻](https://github.com/tellform/tellform/commits?author=toanalien \"Code\") [📖](https://github.com/tellform/tellform/commits?author=toanalien \"Documentation\") | [\u003cimg src=\"https://avatars2.githubusercontent.com/u/8615608?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eAdrian Portabales\u003c/sub\u003e](https://github.com/AdrianP-)\u003cbr /\u003e[🐛](https://github.com/tellform/tellform/issues?q=author%3AAdrianP- \"Bug reports\") [💻](https://github.com/tellform/tellform/commits?author=AdrianP- \"Code\") | [\u003cimg src=\"https://avatars3.githubusercontent.com/u/8433587?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003ePeter Thaleikis\u003c/sub\u003e](https://github.com/spekulatius)\u003cbr /\u003e[📖](https://github.com/tellform/tellform/commits?author=spekulatius \"Documentation\") | [\u003cimg src=\"https://avatars1.githubusercontent.com/u/1247388?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eMickaël Andrieu\u003c/sub\u003e](http://www.mickael-andrieu.com)\u003cbr /\u003e[📖](https://github.com/tellform/tellform/commits?author=mickaelandrieu \"Documentation\") |\n| :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n| [\u003cimg src=\"https://avatars1.githubusercontent.com/u/1522464?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eAhmad Luqman\u003c/sub\u003e](https://github.com/ahmad-luqman)\u003cbr /\u003e[📖](https://github.com/tellform/tellform/commits?author=ahmad-luqman \"Documentation\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/3691490?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003ePeter Dave Hello\u003c/sub\u003e](https://www.peterdavehello.org/)\u003cbr /\u003e[📖](https://github.com/tellform/tellform/commits?author=PeterDaveHello \"Documentation\") |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n## Mentions on the Web\n\n[t3n.de](http://t3n.de/news/open-source-alternative-typeform-tellform-707295/)\n\n[BootCSS Expo](http://expo.bootcss.com/)\n\n[Product Hunt](https://www.producthunt.com/tech/tellform)\n\n[Hacker News Post](https://news.ycombinator.com/item?id=11711095)\n\n[Reddit Posts](https://www.reddit.com/domain/tellform.com/)\n\n[Betapage](https://betapage.co/startup/tellform)\n\n[Opensource.com](http://opensource.com/article/17/2/tools-online-surveys-polls)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftellform%2Ftellform","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftellform%2Ftellform","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftellform%2Ftellform/lists"}