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.

Sign up for GitHub

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

Added .env.example #32

Merged
merged 4 commits into from
Dec 27, 2023
Merged

Added .env.example #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b9fe7cc
Added .env.example
CheatCodeSam Dec 26, 2023
6b8980c
Updated README to reflect .env.example.
CheatCodeSam Dec 27, 2023
f35bc64
Added comment to .env.example
CheatCodeSam Dec 27, 2023
b8f003a
Merge branch 'sublinks:main' into env-example
CheatCodeSam Dec 27, 2023
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
2 changes: 2 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Base URL for the Sublinks API.
SUBLINKS_API_BASE_URL=
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ yarn-error.log*

# local env files
.env*.local
.env

# vercel
.vercel
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Here's how you can opt-out: https://nextjs.org/telemetry#how-do-i-opt-out
npm i
```

### Environment Setup

To run this project, you need to set up the necessary environment variables. A template for these variables can be found in the `.env.example` file.

### Docker

A Docker Compose configuration is made available. This provides an environment which contains a real connection to the Sublinks API and other services. As close to a production-like environment we can test and develop towards locally.
Expand Down