Skip to content

Commit

Permalink
docs: Fixes Getting Started Markdown Extension Usage in Quick Develop…
Browse files Browse the repository at this point in the history
…ment Environment Setup Section (#142)
  • Loading branch information
fcancela authored Dec 9, 2024
1 parent aea2d1c commit 1715d00
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,19 +234,27 @@ We've already covered how to build Superstreamer locally, and we've also made it
$ bun run dev
```

:::

### Quick Development Environment Setup

We have also created a `docker-compose-dev.yml` so you can setup your development environment faster and start getting hands on!

```shell
::: code-group

```sh [Terminal]
# We have prebuilt development containers, see docker/docker-compose-dev.yml
cd docker
docker-compose -f docker-compose-dev.yml up
```

:::

You can create a file named `config.env.development` for a quick setup. Here is a sample that should work out of the box if default configuration is used:

```shell
::: code-group

```sh [config.env.development]
S3_ENDPOINT=http://s3.localhost.localstack.cloud:4566/
S3_REGION=us-east-1
S3_ACCESS_KEY=test
Expand All @@ -272,9 +280,13 @@ SUPER_SECRET=abc
DATABASE_URI=postgresql://postgres:sprs@localhost:5432/sprs
```

:::

Run it with:

```shell
::: code-group

```sh [Terminal]
# Install dependencies
bun install
Expand Down

0 comments on commit 1715d00

Please sign in to comment.