Merge pull request #253 from documenso/docs/add-gitpod-setup

docs: add gitpod setup

.env.gitpod

@@ -0,0 +1,29 @@
+DATABASE_URL="postgres://documenso:password@127.0.0.1:54320/documenso"
+NEXT_PUBLIC_WEBAPP_URL=""
+
+# AUTH
+NEXTAUTH_SECRET='lorem ipsum sit dolor random string for encryption this could literally be anything'
+NEXTAUTH_URL=""
+
+# SIGNING
+CERT_FILE_PATH=""
+CERT_PASSPHRASE=""
+CERT_FILE_ENCODING=""
+
+# EMAIL
+SMTP_MAIL_HOST='127.0.0.1'
+SMTP_MAIL_PORT='2500'
+SMTP_MAIL_USER='documenso'
+SMTP_MAIL_PASSWORD='documenso'
+MAIL_FROM='documenso@gitpod.io'
+
+# STRIPE
+STRIPE_API_KEY=""
+STRIPE_WEBHOOK_SECRET=""
+NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_MONTHLY_PRICE_ID=""
+NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_YEARLY_PRICE_ID=""
+
+#FEATURE FLAGS
+# Allow users to register via the /signup page. Otherwise they will be redirect to the home page.
+NEXT_PUBLIC_ALLOW_SIGNUP=true
+NEXT_PUBLIC_ALLOW_SUBSCRIPTIONS=false

.gitpod.yml

@@ -0,0 +1,60 @@
+tasks:
+  - name: Dependencies & Database
+    init: |
+      npm install &&
+      npm run docker:compose-up &&
+      cp .env.gitpod .env &&
+      next_auth_secret=$(openssl rand -base64 32) &&
+      sed -i -e "s|^NEXTAUTH_SECRET=.*|NEXTAUTH_SECRET=$next_auth_secret|" .env &&
+      sed -i "s|NEXTAUTH_URL=\"\"|NEXTAUTH_URL=https://3000-${HOSTNAME}.${GITPOD_WORKSPACE_CLUSTER_HOST}|" .env && 
+      sed -i "s|NEXT_PUBLIC_WEBAPP_URL=\"\"|NEXT_PUBLIC_WEBAPP_URL=https://3000-${HOSTNAME}.${GITPOD_WORKSPACE_CLUSTER_HOST}|" .env
+    command: npm run d
+
+  - name: Database Studio
+    command: |
+      gp ports await 3000
+      npm run db-studio
+
+ports:
+  - name: App
+    port: 3000
+    visibility: public
+    onOpen: open-browser
+
+  - name: Mailbox
+    port: 9000
+    visibility: public
+    onOpen: open-browser
+
+  - name: Database
+    port: 54320
+    visibility: private
+    onOpen: ignore
+
+  - name: Mailserver
+    port: 2500
+    visibility: private
+    onOpen: ignore
+
+  - name: Database Studio
+    port: 5555
+    visibility: public
+
+  - port: 1100
+    visibility: private
+    onOpen: ignore
+
+github:
+  prebuilds:
+    master: true
+    pullRequests: true
+    pullRequestsFromForks: true
+    addCheck: true
+    addComment: true
+    addBadge: true
+
+vscode:
+  extensions:
+    - esbenp.prettier-vscode
+    - bradlc.vscode-tailwindcss
+    - Prisma.prisma

README.md

@@ -139,6 +139,8 @@ Your database will also be available on port `54320`. You can connect to it usin
 
 ## Developer Setup
 
+### Manual Setup
+
 Follow these steps to setup documenso on you local machine:
 
 - [Clone the repository](https://help.github.com/articles/cloning-a-repository/) it to your local device.
@@ -169,6 +171,12 @@ Follow these steps to setup documenso on you local machine:
   - A demo certificate is provided in `/app/web/resources/certificate.p12`
   - To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL) see **[Create your own signing certificate](#creating-your-own-signing-certificate)**.
 
+### Run in Gitpod
+
+- Click below to launch a ready-to-use Gitpod workspace in your browser.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/documenso/documenso)
+
 ## Updating
 
 - If you pull the newest version from main, using `git pull`, it may be necessary to regenerate your database client