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

Jump to bottom

chore(env): add .env.example and related docs #307

Merged
merged 1 commit into from
Jul 23, 2024
Merged

chore(env): add .env.example and related docs #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## This file is an example of the .env and .env.docker files you should have before running docker-compose command

PINO_PRETTIFY="true"
DATABASE_URL=postgresql://postgres:postgres@postgres:5432/pezzo
SUPERTOKENS_CONNECTION_URI="http://supertokens:3567"
CONSOLE_HOST="http://pezzo-console:4200"
KAFKA_BROKERS="kafka:9092"
OPENSEARCH_URL="http://opensearch:9200"
REDIS_URL="redis://redis-stack-server:6379"

NX_BASE_API_URL="http://localhost:3000"
NX_SUPERTOKENS_API_DOMAIN="http://localhost:3000"
NX_SUPERTOKENS_WEBSITE_DOMAIN="http://localhost:4200"
NX_DEBUG_MODE="true"
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,13 @@ Install NPM dependencies by running:
npm install
```

### Set up the environment files

Pezzo uses a .env file to store environment variables.
When using docker, you should also create a .env.docker file.

See the .env.example file for reference.

### Spin up infrastructure dependencies via Docker Compose

Pezzo is entirely cloud-native and relies solely on open-source technologies such as [PostgreSQL](https://www.postgresql.org/), [ClickHouse](https://github.com/ClickHouse/ClickHouse), [Redis](https://github.com/redis/redis) and [Supertokens](https://supertokens.com/).
Expand Down
Loading