TellForm 2.0.0

An opensource alternative to TypeForm that can create stunning mobile-ready forms , surveys and questionnaires.

Table of Contents

• Features
• How to Contribute
• Quickstart
• Deploying with Docker
• Testing your Application
• FORMA
• Where to Get Help
• Sponsors
• Backers
• Contributors
• 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. 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 installed and running at 127.0.0.1:6379
2. MongoDB 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 or equivalent if running it locally on your computer (look at dns_masq_setup_osx for instructions on OSX)

Install dependencies first.

$ npm install
$ bower install

Setup environment.

$ grunt build

Create your user account

$ 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 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

Deploying with Docker

To deploy with docker, first install docker here.

Then run these commands

$ docker run -p 27017:27017 -d --name some-mongo mongo
$ docker run -p 127.0.0.1:6379:6379 -d --name some-redis redis
$ docker run --rm -p 3000:3000 --link some-redis:redis-db --link some-mongo:db -e "SUBDOMAINS_DISABLED=TRUE" -e "DISABLE_CLUSTER_MODE=TRUE" -e "MAILER_EMAIL_ID=<YourEmailAPI_ID>" -e "MAILER_FROM=<noreply@yourdomain.com>" -e "MAILER_SERVICE_PROVIDER=<YourEmailAPIProvider>"  -e "MAILER_PASSWORD=<YourAPIKey>" -e "BASE_URL=localhost" -p 80:80 tellform/development

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

$ grunt coverage

To calculate your server-side test coverage with Istanbul, run the coverage task

$ grunt coverage:server

To calculate your client-side test coverage with Istanbul, run the coverage task

$ grunt coverage:client

FORMA

Prerequisite:

Before you start, make sure you have

1. Redis installed and running at 127.0.0.1:6379
2. MongoDB installed and running at 127.0.0.1:27017 (OR specify the host and port in config/env/all)
3. Docker installed and running

Also make sure to install DNS Masq or equivalent if running it locally on your computer (look at dns_masq_setup_osx for instructions on OSX)

Install dependencies:

$ npm install
$ bower install

Prepare .env file:

Create .env file at project root folder. Fill in MAILER_EMAIL_ID and MAILER_PASSWORD, and either MAILER_SERVICE_PROVIDER using a Nodemailer Well-known service or MAILER_SMTP_HOST, MAILER_SMTP_PORT, and MAILER_SMTP_SECURE for a custom SMTP server.

APP_NAME=forma
APP_DESC=
APP_KEYWORDS=
NODE_ENV=development
BASE_URL=localhost:5000
PORT=5000
username=forma_admin
SIGNUP_DISABLED=false
SUBDOMAINS_DISABLED=true
DISABLE_CLUSTER_MODE=true
GOOGLE_ANALYTICS_ID=
RAVEN_DSN=
PRERENDER_TOKEN=
COVERALLS_REPO_TOKEN=

# Mail config
MAILER_EMAIL_ID=forma@data.gov.sg
MAILER_PASSWORD=some-pass
MAILER_FROM=forma@data.gov.sg

# Use this for one of Nodemailer's pre-configured service providers
MAILER_SERVICE_PROVIDER=

# Use these for a custom service provider 
# Note: MAILER_SMTP_HOST will override MAILER_SERVICE_PROVIDER
MAILER_SMTP_HOST=
MAILER_SMTP_PORT=465
MAILER_SMTP_SECURE=true

Note: You can view the compatible types for MAILER_SERVICE_PROVIDER here

Deploy with Docker:

Create and start mongo & redis docker container.

$ docker run -p 27017:27017 -d --name forma-mongo mongo
$ docker run -p 127.0.0.1:6379:6379 -d --name forma-redis redis

After code changes, build and start docker containers.

$ docker start forma-mongo && docker start forma-redis
$ docker build -t forma-tellform .
$ docker stop forma-tellform
$ docker run --rm -p 5000:5000 --link forma-redis:redis-db --link forma-mongo:db --name forma-tellform forma-tellform

Your application should run on port 5000 or the port you specified in your .env file, so in your browser just go to http://localhost:5000

Where to get help

Gitter Chat

Official Twitter

Sponsors

Does your company use TellForm? Help keep the project bug-free and feature rich by sponsoring the project.

Backers

Love our work and community? Become a backer.

Contributors

David Baldwynn 💻 🔧 🚇 📖 💡 🎨 🔍 👀 ⚠️	Samuel Laulhau 💻 🌍	Arun Pattnaik 🎨	Thiên Toán 🐛 💻 📖	Adrian Portabales 🐛 💻	Peter Thaleikis 📖	Mickaël Andrieu 📖
Ahmad Luqman 📖	Peter Dave Hello 📖

Mentions on the Web

Mister Ad

t3n.de

BootCSS Expo

Product Hunt

Hacker News Post

Reddit Posts

Betapage

Opensource.com