TellForm 2.1.0

DEPRECATION WARNING UNTIL FURTHER NOTICE. There are many oudated and vulnerable dependencies within this project and I recommend that you use this code repository for internal testing and development only.

There 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.

<!-- [](https://www.codeshelter.co/) [](https://travis-ci.org/tellform/tellform)  [](https://www.codacy.com/app/david-baldwin/tellform?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tellform/tellform&amp;utm_campaign=Badge_Grade) -->

To Join the fork's community please follow this Discord button here.

Readme and Issues

The 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.

No 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 or its GitHub repository at 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.

<!-- > An *opensource alternative to TypeForm* that can create [stunning mobile-ready forms](https://tellform.com/examples) , surveys and questionnaires.--> <!-- [](https://heroku.com/deploy?template=https://github.com/tellform/tellform/tree/master) --> <!-- ## Table of Contents - [Features](#features) - [How to Contribute](#how-to-contribute) - [Quickstart](#quickstart) - [Deploying with Docker](#deploying-with-docker) - [Testing your Application](#testing-your-application) - [Advanced Configuration](#configuration) - [Where to Get Help](#where-to-get-help) - [Sponsors](#sponsors) - [Backers](#backers) - [Contributors](#contributors) - [Mentions on the Web](#mentions-on-the-web) ## Features ### Currently following features are implemented: - Multi-Language Support - 11 possible question types - Editable start and end pages - Export Submissions to XLS, JSON or CSV - Native Analytics and Google Analytics Support - Custom Subdomains for each User - Embeddable Forms - Forms as a Service API - Deployable with Heroku and DockerHub ### On the Roadmap for v3.0.0 - Implement encryption for all form data - Add Typeform API integration - Add plugin/3rd party integration support (ala Slack) - Create wiki for easy installation and setup - Add Stripe/Payment Form field - Add Custom Background and Dropdown Field Images - Add File Upload Form Field ## How to Contribute Please checkout our CONTRIBUTING.md on ways to contribute to TellForm. All 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. ## Quickstart Before you start, make sure you have 1. [Redis](https://redis.io/) installed and running at 127.0.0.1:6379 2. [MongoDB](https://www.mongodb.com/) installed and running at 127.0.0.1:27017 (OR specify the host and port in config/env/all) Also 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) Install dependencies first. ```bash $ npm install $ bower install ``` Setup environment. ```bash $ grunt build ``` Create your user account ```bash $ node ./scripts/setup.js ``` OR create your .env file ``` GOOGLE_ANALYTICS_ID=yourGAID PRERENDER_TOKEN=yourPrerender.ioToken COVERALLS_REPO_TOKEN=yourCoveralls.ioToken BASE_URL=localhost DSN_KEY=yourPrivateRavenKey # Mail config MAILER_EMAIL_ID=user@domain.com MAILER_PASSWORD=some-pass MAILER_FROM=user@domain.com # Use this for one of Nodemailer's pre-configured service providers MAILER_SERVICE_PROVIDER=SendGrid # Use these for a custom service provider # Note: MAILER_SMTP_HOST will override MAILER_SERVICE_PROVIDER MAILER_SMTP_HOST=smtp.domain.com MAILER_SMTP_PORT=465 MAILER_SMTP_SECURE=TRUE ``` Side 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___ #### To run the development version: Set ```NODE_ENV=development``` in .env file ```$ grunt``` #### To run the production version: Set ```NODE_ENV=production``` in .env file ```$ grunt``` Your 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) ## Deploying with Docker To deploy with docker, first install docker [here](https://docs.docker.com/engine/installation/). Then run follow these steps: ### Step 1: Clone the repo `$ git clone https://github.com/tellform/docker_files.git` ### Step 2: Setup TellForm Configuration Create your .env file by copying the .env.dist file included in the repo and changing it to suit your deployment. Important: You need to fill out all of the ENV variables in the "Mail Settings" section or your TellForm instance won't work. If you want to have https, make sure to change 'TLS_FLAVOR' ### Step 3: Start your TellForm instance `docker-compose up -d` TellForm should now be accessible on http://localhost ## Testing Your Application You can run the full test suite included with TellForm with the test task: ``` $ grunt test ``` This will run both the server-side tests (located in the app/tests/ directory) and the client-side tests (located in the public/modules/*/tests/). To execute only the server tests, run the test:server task: ``` $ grunt test:server ``` And to run only the client tests, run the test:client task: ``` $ grunt test:client ``` Currently 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. To calculate your total test coverage with Istanbul, run the coverage task ```bash $ grunt coverage ``` To calculate your server-side test coverage with Istanbul, run the coverage task ```bash $ grunt coverage:server ``` To calculate your client-side test coverage with Istanbul, run the coverage task ```bash $ grunt coverage:client ``` ## Configuration TellForm'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`. | Property | Valid Values | Default Value | Description | Required? | |-------------------------|--------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------| | 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 | | SESSION_SECRET | Any string | CHANGE_ME_PLEASE | Value used to compute session hash | No | | BASE_URL | A valid URL | localhost:3000 | URL where the admin panel will live | Yes | | MONGODB_URI | A valid MongoDB URI | localhost/mean | URI of the MONGODB server/db that your server will use | Yes | | REDIS_URL | A valid Redis URI | redis://127.0.0.1:6379 | URI of the Redis instance that your server will