From edbab36d27b2ef33b393bfd49d620b47452df7d8 Mon Sep 17 00:00:00 2001 From: Rotimi Best Date: Wed, 27 Sep 2023 15:03:26 +0100 Subject: [PATCH] docs: update development and self-hosting information in README (#860) * docs: add prerequisities to readme.md * docs: reorganize getting started section in README * docs: break docker into its own section * update self-hosting structure --------- Co-authored-by: Matthias Nannt --- README.md | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 65aa009456..c808514cb1 100644 --- a/README.md +++ b/README.md @@ -63,23 +63,48 @@ Formbricks helps you apply best practices from data-driven work and experience m ## 🚀 Getting started +We've got several options depending on your need to help you quickly get started with Formbricks + ### ☁️ Cloud Version Formbricks has a hosted cloud offering with a generous free plan to get you up and running as quickly as possible. To get started, please visit [formbricks.com](https://formbricks.com) ### 🐳 Self-hosted version -Formbricks is available Open-Source under AGPLv3 license. You can host Formbricks on your own servers using Docker without a subscription. To get started with self-hosting, take a look at our [self-hosting docs](https://formbricks.com/docs/self-hosting/deployment). +Formbricks is available Open-Source under AGPLv3 license. You can host Formbricks on your own servers using Docker without a subscription. -(In the future we may develop additional features that aren't in the free Open-Source version) +(In the future we may develop additional features that aren't in the free Open-Source version). -### Development +If you opt for self-hosting Formbricks, here are a few options to consider: + +#### Docker + +To get started with self-hosting with Docker, take a look at our [self-hosting docs](https://formbricks.com/docs/self-hosting/deployment). + +#### Community managed One Click Hosting + +##### Railway + +You can deploy Formbricks on [Railway](https://railway.app) using the button below. + +[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/PPDzCd) + +### 👨‍💻 Development + +#### Prerequisites + +Here is what you need to be able to run Formbricks + +- Node.js (Version: >=18.x) +- [Pnpm](https://pnpm.io/) +- [Docker](https://www.docker.com/) - to run PostgreSQL and MailHog #### Local Setup To get started locally, we've got a [guide to help you](https://formbricks.com/docs/contributing/setup). #### Gitpod Setup + 1. Click the button below to open this project in Gitpod. 2. This will open a fully configured workspace in your browser with all the necessary dependencies already installed. @@ -98,13 +123,6 @@ Here are a few options: Please check out [our contribution guide](https://formbricks.com/docs/contributing/introduction) and our [list of open issues](https://github.com/formbricks/formbricks/issues) for more information. -## 🧑‍💻 Community managed One Click Hosting -### Railway -[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/PPDzCd) - -You can deploy Formbricks on [Railway](https://railway.app) using the button above. - - ## 📆 Contact us Let's have a chat about your survey needs and get you started.