Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bnussman committed Oct 31, 2023
1 parent 12c9ae2 commit 9bb0b55
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ name: e2e
on:
push:
branches:
- main
- production
- main
- production
pull_request:

jobs:
test:
timeout-minutes: 60
timeout-minutes: 15
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down Expand Up @@ -37,7 +38,7 @@ jobs:
run: pnpm i --frozen-lockfile
- name: Install Playwright Browsers
run: pnpm exec playwright install --with-deps chromium
- name: Start DB and Redis
- name: Start Docker services (PostgreSQL, Redis, and S3)
run: docker compose up -d
- name: Build the api
run: pnpm build:api
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ To run the development envrionment use in the repo's root
pnpm dev
```

By default, the api will use your local database and redis from docker. You should not need an `.env` to develop locally
You can create a `.env` in `api/` to set the API's env. (`vim api/.env`)
By default, the api will use your local database, redis, and s3 server from docker. You should not need an `.env` to develop locally
You can create a `.env` in `api/` to set the API's env if needed. (`vim api/.env`)

```env
S3_ACCESS_KEY_ID=hkjvbyuverbvugfreukgsig
Expand Down

0 comments on commit 9bb0b55

Please sign in to comment.