dx: improve getting started

Author: zcesur

.env.example

@@ -1,51 +1,44 @@
 PORT=4000
-LOG_LEVEL=debug
-
-LOGIN_CODE_TTL=600
-LOGIN_CODE_SALT="algora-login-code"
-LOCAL_STORE_TTL=3600
-LOCAL_STORE_SALT="algora-local-store"
+LOG_LEVEL=info
 
 DATABASE_URL="postgresql://postgres:postgres@localhost:15432/algora_dev"
+TEST_DATABASE_URL="postgresql://postgres:postgres@localhost:15432/algora_test"
 
 GITHUB_CLIENT_ID=""
 GITHUB_CLIENT_SECRET=""
 GITHUB_APP_HANDLE=""
 GITHUB_APP_ID=""
 GITHUB_WEBHOOK_SECRET=""
 GITHUB_PRIVATE_KEY=""
-GITHUB_PAT=""
-GITHUB_PAT_ENABLED=false
 GITHUB_OAUTH_STATE_TTL=600
 GITHUB_OAUTH_STATE_SALT="github-oauth-state"
 
+STRIPE_PUBLISHABLE_KEY=""
+STRIPE_SECRET_KEY=""
+STRIPE_WEBHOOK_SECRET=""
+
 AWS_ENDPOINT_URL_S3=""
 AWS_REGION=""
 AWS_ACCESS_KEY_ID=""
 AWS_SECRET_ACCESS_KEY=""
 BUCKET_NAME=""
 
-STRIPE_PUBLISHABLE_KEY=""
-STRIPE_SECRET_KEY=""
-STRIPE_WEBHOOK_SECRET=""
-
-STRIPE_TEST_CUSTOMER_ID=""
-STRIPE_TEST_ACCOUNT_ID=""
-
-CLOUDFLARE_TUNNEL=""
-
 APPSIGNAL_OTP_APP="algora"
 APPSIGNAL_PUSH_API_KEY="00000000-0000-0000-0000-000000000000"
 APPSIGNAL_APP_NAME="AlgoraConsole"
 APPSIGNAL_APP_ENV="dev"
 
 SENDGRID_API_KEY="SG.x.x"
 
-DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/1234567890/x"
-
-PLAUSIBLE_EMBED_URL=""
+LOGIN_CODE_TTL=600
+LOGIN_CODE_SALT="algora-login-code"
+LOCAL_STORE_TTL=3600
+LOCAL_STORE_SALT="algora-local-store"
 
+CLOUDFLARE_TUNNEL=""
 ASSETS_URL=""
 INGEST_URL=""
 INGEST_STATIC_URL=""
-INGEST_TOKEN=""
+INGEST_TOKEN=""
+PLAUSIBLE_EMBED_URL=""
+DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/1234567890/x"

README.md

@@ -166,6 +166,24 @@ We also recommend using [direnv](https://github.com/direnv/direnv) to load envir
 
 Some features of Algora rely on external services. If you're not planning on using these features, feel free to skip setting them up.
 
+#### Tunnel
+
+To receive webhooks from GitHub or Stripe on your local machine, you'll need a way to expose your local server to the internet. The easiest way to get up and running is to use a tool like [ngrok](https://ngrok.com/) or [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/).
+
+Here's how you can setup a re-usable named tunnel on your own domain name so you have a consistent URL:
+
+```sh
+cloudflared tunnel login
+cloudflared tunnel create local
+cloudflared tunnel route dns local http://local.yourdomain.com
+```
+
+Once you have setup your tunnel, add it to your `.env` file and run `direnv allow .env`.
+
+```env
+CLOUDFLARE_TUNNEL="local"
+```
+
 #### GitHub
 
 [Register new GitHub app](https://github.com/settings/apps/new) and set
@@ -182,7 +200,7 @@ Some features of Algora rely on external services. If you're not planning on usi
   - Read account email address
 - Events: issues, pull requests, issue comment, pull request review, pull request review comment
 
-Once you have obtained your client ID and secret, add them to your `.env` file and run `direnv allow .env`
+Once you have obtained your client ID and secret, add them to your `.env` file.
 
 ```env
 GITHUB_CLIENT_ID=""

lib/algora/application.ex

@@ -32,6 +32,7 @@ defmodule Algora.Application do
     children =
       case Application.get_env(:algora, :cloudflare_tunnel) do
         nil -> children
+        "" -> children
         tunnel -> children ++ [{Algora.Tunnel, tunnel}]
       end
 

mix.exs

@@ -129,7 +129,7 @@ defmodule Algora.MixProject do
       test: ["ecto.create --quiet", "ecto.migrate --quiet", "test"],
       "test.reset": ["cmd MIX_ENV=test mix do ecto.drop, ecto.create, ecto.migrate"],
       "assets.setup": ["tailwind.install --if-missing"],
-      "assets.build": ["tailwind algora", "cmd --cd assets pnpm install"],
+      "assets.build": ["cmd --cd assets pnpm install", "tailwind algora"],
       "assets.deploy": [
         "tailwind algora --minify",
         "cmd --cd assets node build.js --deploy",