diff --git a/README.md b/README.md index 3def55db..873ae8f2 100755 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ 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) @@ -157,6 +158,7 @@ $ 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) @@ -165,11 +167,12 @@ Before you start, make sure you have 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. +#### Install dependencies: ``` $ npm install ``` +#### Prepare .env file: Create .env file at project root folder. Fill in MAILER_SERVICE_PROVIDER, MAILER_EMAIL_ID and MAILER_PASSWORD. ``` APP_NAME=forma @@ -254,7 +257,7 @@ Love our work and community? [Become a backer](https://opencollective.com/tellfo -## Contributors +## Contributors | [
David Baldwynn](http://baldwynn.me)
[πŸ’»](https://github.com/tellform/TellForm/commits?author=whitef0x0 "Code") [πŸ”§](#tool-whitef0x0 "Tools") [πŸš‡](#infra-whitef0x0 "Infrastructure (Hosting, Build-Tools, etc)") [πŸ“–](https://github.com/tellform/TellForm/commits?author=whitef0x0 "Documentation") [πŸ’‘](#example-whitef0x0 "Examples") [🎨](#design-whitef0x0 "Design") [πŸ”](#fundingFinding-whitef0x0 "Funding Finding") [πŸ‘€](#review-whitef0x0 "Reviewed Pull Requests") [⚠️](https://github.com/tellform/TellForm/commits?author=whitef0x0 "Tests") | [
Samuel Laulhau](https://samuellaulhau.fr)
[πŸ’»](https://github.com/tellform/TellForm/commits?author=lalop "Code") [🌍](#translation-lalop "Translation") | [
Arun Pattnaik](http://arun.co)
[🎨](#design-arunpattnaik "Design") | [
ThiΓͺn ToΓ‘n](https://toanalien.com)
[πŸ›](https://github.com/tellform/TellForm/issues?q=author%3Atoanalien "Bug reports") [πŸ’»](https://github.com/tellform/TellForm/commits?author=toanalien "Code") [πŸ“–](https://github.com/tellform/TellForm/commits?author=toanalien "Documentation") | [
Adrian Portabales](https://github.com/AdrianP-)
[πŸ›](https://github.com/tellform/TellForm/issues?q=author%3AAdrianP- "Bug reports") [πŸ’»](https://github.com/tellform/TellForm/commits?author=AdrianP- "Code") | [
Peter Thaleikis](https://github.com/spekulatius)
[πŸ“–](https://github.com/tellform/TellForm/commits?author=spekulatius "Documentation") | [
MickaΓ«l Andrieu](http://www.mickael-andrieu.com)
[πŸ“–](https://github.com/tellform/TellForm/commits?author=mickaelandrieu "Documentation") |