An opensource alternative to TypeForm that can create stunning mobile-ready forms , surveys and questionnaires.
- Features
- How to Contribute
- Quickstart
- Deploying with Docker
- Testing your Application
- FORMA
- Where to Get Help
- Sponsors
- Backers
- Contributors
- Mentions on the Web
- 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
- 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
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.
Before you start, make sure you have
- Redis installed and running at 127.0.0.1:6379
- 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
MAILER_EMAIL_ID=SMTP_Injection
MAILER_FROM=noreply@yourdomain.com
MAILER_PASSWORD=your_sendgrid_apikey
MAILER_SERVICE_PROVIDER=SendGrid
BASE_URL=localhost
DSN_KEY=yourPrivateRavenKey
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
Set NODE_ENV=development
in .env file
$ grunt
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
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
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
Before you start, make sure you have
- Redis installed and running at 127.0.0.1:6379
- MongoDB installed and running at 127.0.0.1:27017 (OR specify the host and port in config/env/all)
- 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)
$ npm install
$ bower install
Create .env file at project root folder. Fill in MAILER_SERVICE_PROVIDER, MAILER_EMAIL_ID and MAILER_PASSWORD.
APP_NAME=forma
APP_DESC=
APP_KEYWORDS=
NODE_ENV=development
BASE_URL=localhost:5000
PORT=5000
username=forma_admin
MAILER_SERVICE_PROVIDER=
MAILER_EMAIL_ID=
MAILER_PASSWORD=
MAILER_FROM=forma@data.gov.sg
SIGNUP_DISABLED=false
SUBDOMAINS_DISABLED=true
DISABLE_CLUSTER_MODE=true
GOOGLE_ANALYTICS_ID=
RAVEN_DSN=
PRERENDER_TOKEN=
COVERALLS_REPO_TOKEN=
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
Does your company use TellForm? Help keep the project bug-free and feature rich by sponsoring the project.
Love our work and community? Become a backer.
David Baldwynn 💻 🔧 🚇 📖 💡 🎨 🔍 👀 |
Samuel Laulhau 💻 🌍 |
Arun Pattnaik 🎨 |
Thiên Toán 🐛 💻 📖 |
Adrian Portabales 🐛 💻 |
Peter Thaleikis 📖 |
Mickaël Andrieu 📖 |
---|---|---|---|---|---|---|
Ahmad Luqman 📖 |
Peter Dave Hello 📖 |