diff --git a/README.md b/README.md index b4e839c8..42f5e735 100755 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ TellForm 2.0.0 - [Quickstart](#quickstart) - [Deploying with Docker](#deploying-with-docker) - [Testing your Application](#testing-your-application) -- [FORMA](#forma) - [Where to Get Help](#where-to-get-help) - [Sponsors](#sponsors) - [Backers](#backers) @@ -167,76 +166,6 @@ 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](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) -3. [Docker](https://docs.docker.com/engine/installation/) installed and running - -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: -``` -$ 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](https://nodemailer.com/smtp/well-known/) 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](https://nodemailer.com/smtp/well-known/) - -#### 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](http://localhost:5000) - - ## Where to get help [Gitter Chat](https://gitter.im/whitef0x0/tellform)