From 33591baba7744bea116ba2131ced16e55ffcb017 Mon Sep 17 00:00:00 2001
From: Tadashi Shigeoka <tadashi.shigeoka@route06.co.jp>
Date: Fri, 18 Oct 2024 15:52:24 +0900
Subject: [PATCH 1/3] Add .env.example

---
 .env.example | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 00000000..0d7115ae
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,81 @@
+# Giselle app
+NEXT_PUBLIC_SERVICE_SITE_URL="https://example.com/"
+
+# @vercel/blob https://vercel.com/docs/storage/vercel-blob/using-blob-sdk
+# @see https://vercel.com/docs/storage/vercel-blob/client-upload#prepare-your-local-project
+BLOB_READ_WRITE_TOKEN=
+
+# Firecrawl https://www.firecrawl.dev/
+# @see https://docs.firecrawl.dev/introduction#api-key
+FIRECRAWL_API_KEY=
+
+# @vercel/flags API Reference https://vercel.com/docs/workflow-collaboration/feature-flags/vercel-flags
+# @see https://vercel.com/docs/workflow-collaboration/feature-flags/supporting-feature-flags#flags_secret-environment-variable
+FLAGS_SECRET=
+
+# Google Tag Manager https://tagmanager.google.com/
+# @see https://support.google.com/tagmanager/answer/6102821
+GTM_ID=
+
+# Langfuse https://langfuse.com/
+# @see https://langfuse.com/docs/get-started
+LANGFUSE_BASEURL=
+LANGFUSE_PUBLIC_KEY=
+LANGFUSE_SECRET_KEY=
+
+# OpenAI API https://openai.com/index/openai-api/
+# @see https://platform.openai.com/docs/quickstart
+OPENAI_API_KEY=
+
+# Vercel Postgres https://vercel.com/docs/storage/vercel-postgres
+# @see https://vercel.com/docs/storage/vercel-postgres#getting-started
+POSTGRES_DATABASE=
+POSTGRES_HOST=
+POSTGRES_PASSWORD=
+POSTGRES_PRISMA_URL=
+POSTGRES_URL=
+POSTGRES_URL_NON_POOLING=
+POSTGRES_URL_NO_SSL=
+POSTGRES_USER=
+
+# Sentry https://sentry.io/
+# @see https://docs.sentry.io/cli/configuration/
+SENTRY_AUTH_TOKEN=
+
+# SigNoz https://signoz.io/
+# @see https://signoz.io/docs/cloud/
+SIGNOZ_ACCESS_TOKEN=
+SIGNOZ_INGESTION_TOKEN=
+
+# Stripe https://stripe.com/
+# @see https://docs.stripe.com/keys
+STRIPE_PRICE_ID=
+STRIPE_SECRET_KEY=
+NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=
+
+# Supabase https://supabase.com/
+# @see https://supabase.com/docs/guides/getting-started/tutorials/with-nextjs#initialize-a-nextjs-app
+NEXT_PUBLIC_SUPABASE_ANON_KEY=
+NEXT_PUBLIC_SUPABASE_URL=
+
+# Tavily https://tavily.com/
+# @see https://docs.tavily.com/docs/welcome#getting-started
+TAVILY_API_KEY=
+
+# Trigger.dev https://trigger.dev/
+# @see https://trigger.dev/docs/apikeys
+TRIGGER_SECRET_KEY=
+
+# Unstructured https://unstructured.io/
+# @see https://docs.unstructured.io/api-reference/api-services/saas-api-development-guide
+UNSTRUCTURED_API_KEY=
+
+# ---
+# for development only
+# ---
+# AUTH_GOOGLE_ID=
+# AUTH_GOOGLE_SECRET=
+# AUTH_SECRET=
+# NEXTAUTH_URL="http://localhost:3000"
+# GITHUB_APP_CLIENT_ID=
+# GITHUB_APP_CLIENT_SECRET=

From 74853f64f4f3c2fcff5972d6c689d0d9c16e0b1b Mon Sep 17 00:00:00 2001
From: Tadashi Shigeoka <tadashi.shigeoka@route06.co.jp>
Date: Fri, 18 Oct 2024 16:04:10 +0900
Subject: [PATCH 2/3] Update "Development environment setup" section in
 CONTRIBUTING.md

---
 CONTRIBUTING.md | 28 +++++++++++++++++++++++-----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d7da97b8..372410f4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,13 +10,31 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
 
 To set up a development environment, please follow these steps:
 
-1. Clone the repo
+### 1. Fork this repository and clone it
 
-   ```sh
-   git clone https://github.com/route06inc/giselle
-   ```
+1. [Fork this repository](https://github.com/route06inc/giselle/fork) to your own GitHub account
+2. [Clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
 
-2. [TODO]
+### 2. Prerequisites
+
+- Bun (Version: >= 1.1.17)
+
+### 3. Set up your .env file
+
+1. Duplicate .env.example to .env.
+2. Please set the environment variables in the .env file.
+
+### 4. Install dependencies
+
+```sh
+bun install
+```
+
+### 5. Start developing and watch for code changes
+
+```sh
+bun dev
+```
 
 ## Issues and feature requests
 

From 0a2851a3dab38591e189d38ff7bc2e5758383595 Mon Sep 17 00:00:00 2001
From: Tadashi Shigeoka <tadashi.shigeoka@route06.co.jp>
Date: Fri, 18 Oct 2024 16:05:24 +0900
Subject: [PATCH 3/3] Add `.env.example` to .vercelignore

---
 .vercelignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.vercelignore b/.vercelignore
index 9186286a..ec739e4b 100644
--- a/.vercelignore
+++ b/.vercelignore
@@ -1,3 +1,4 @@
+.env.example
 .github
 .zed
 *.md