We've made some changes and will continue to be changing this particular fork of TellForm to comply with our guidelines.
Below you will find a changelog.
(newest to oldest)
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
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
$ 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_IDfirstname.lastname@example.org MAILER_PASSWORD=some-pass MAILER_FROMemail@example.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
NODE_ENV=development in .env file
NODE_ENV=production in .env file
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 see this page here for commands on how to deploy your own local TellForm instance.
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
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
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.