chore: update env variables examples

avitorio · Feb 17, 2024 · 890384b · 890384b
1 parent a92f5df
commit 890384b
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 15 deletions.
diff --git a/apps/docs/.env.local.example b/apps/docs/.env.local.example
@@ -1,22 +1,15 @@
+## This is an example of a .env.local file for the Outstatic documentation website
+## You can copy this file and rename it to .env.local and fill in the required environment variables
+
 # REQUIRED Environment variables
 OST_GITHUB_ID=YOUR_GITHUB_OAUTH_ID
 OST_GITHUB_SECRET=YOUR_GITHUB_OAUTH_SECRET
 OST_TOKEN_SECRET=A_32CHAR_RANDOM_STRING_FOR_YOUR_TOKEN_SECRET
 OST_REPO_SLUG=THE_REPOSITORY_SLUG 
-# If empty AND on Vercel, your OST_REPO_SLUG defaults to VERCEL_GIT_REPO_SLUG
-
-# OPTIONAL Environment variables
-
-# If empty, OST_REPO_BRANCH defaults to main
-# OST_REPO_BRANCH=THE_REPOSITORY_BRANCH
-
-# # If empty, OST_REPO_OWNER the GitHub username of the logged in account will be used
-# OST_REPO_OWNER=THE_REPO_OWNER
-
-# # OST_CONTENT_PATH is the path of where content is saved, if empty it defaults to outstatic/content
-# OST_CONTENT_PATH=outstatic/content 
-
-# # Specify monorepo folder of your Outstatic content
-# OST_MONOREPO_PATH=apps/web
+OST_REPO_OWNER=THE_REPO_OWNER
+OST_REPO_SLUG=YOUR_REPO_SLUG
+OST_REPO_BRANCH=REPO_BRANCH_OR_PR_BRANCH
+OST_MONOREPO_PATH=apps/docs
+OPENAI_API_KEY=YOUR_OPEN_AI_API_KEY
 
 # For more information visit: https://outstatic.com/docs/environment-variables
diff --git a/examples/advanced-blog/.env.local.example b/examples/advanced-blog/.env.local.example
@@ -1,3 +1,5 @@
+NEXT_PUBLIC_APP_URL=http://localhost:3000
+
 # REQUIRED Environment variables
 OST_GITHUB_ID=YOUR_GITHUB_OAUTH_ID
 OST_GITHUB_SECRET=YOUR_GITHUB_OAUTH_SECRET

diff --git a/examples/advanced-blog/README.md b/examples/advanced-blog/README.md
@@ -11,6 +11,11 @@
 - [Vercel OG](https://vercel.com/docs/functions/og-image-generation)
 - And more, check out our `package.json` to see a full list of tech used.
 
+## Set up
+
+Please, visit our [getting started](https://outstatic.com/docs/getting-started) guide.
+Don't forget to check the `.env.local.example` file for environment variables.
+
 ## Example
 
 [AndreVitorio.com](https://AndreVitorio.com)

diff --git a/examples/basic-blog/.env.local.example b/examples/basic-blog/.env.local.example
@@ -1,3 +1,5 @@
+NEXT_PUBLIC_APP_URL=http://localhost:3000
+
 # REQUIRED Environment variables
 OST_GITHUB_ID=YOUR_GITHUB_OAUTH_ID
 OST_GITHUB_SECRET=YOUR_GITHUB_OAUTH_SECRET

diff --git a/examples/basic-blog/README.md b/examples/basic-blog/README.md
@@ -1,3 +1,6 @@
 # A statically generated blog example using Outstatic and Next.js
 
 [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Favitorio%2Foutstatic%2Ftree%2Fmain%2Fexamples%2Fblog&env=OST_GITHUB_ID,OST_GITHUB_SECRET,OST_TOKEN_SECRET&project-name=outstatic-blog&repo-name=outstatic-blog&demo-title=Outstatic%20Blog%20Demo&demo-description=A%20statically%20generated%20blog%20example%20using%20Outstatic&demo-url=https%3A%2F%2Foutstatic-example-blog.vercel.app%2F&demo-image=https%3A%2F%2Foutstatic.com%2Fimages%2Foutstatic-demo.png&envDescription=API%20Keys%20needed%20for%20installation&envLink=https%3A%2F%2Foutstatic.com%2Fdocs%2Fenvironment-variables)
+
+Please, visit our [getting started](https://outstatic.com/docs/getting-started) guide.
+Don't forget to check the `.env.local.example` file for environment variables.