Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "Development environment setup" section in CONTRIBUTING.md #25

Merged
merged 3 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -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=
1 change: 1 addition & 0 deletions .vercelignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.env.example
.github
.zed
*.md
Expand Down
28 changes: 23 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down