Skip to content

Commit

Permalink
docs: smooth out on-boarding for local API testing (#343)
Browse files Browse the repository at this point in the history
I've added a few more tips/hints to get someone from a fresh checkout to
accessing their own dev version of the API server. Should be no impact
on the more public-facing (client library) documentation, just
clarifying/extending the local environment setup notes.
  • Loading branch information
natevw authored Jan 18, 2023
1 parent d6bad1f commit 4def90c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
3 changes: 3 additions & 0 deletions packages/access-api/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
## Development

Run the root [instructions](../../readme.md#setup-a-development-environment) first.
Review the repo-wide `.env` file copied in those steps and fill in real API keys for any services you plan to test against.

```bash
# Run api locally
Expand All @@ -16,6 +17,8 @@ pnpm run lint
pnpm run test
```

The dev API server is currently hardcoded to listen on port 8787 on unspecified (i.e. typically: all) network interfaces.

## Migrations

### Create migration
Expand Down
5 changes: 3 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ npx simple-git-hooks
cp .env.tpl .env
```

The individual packages may have additional setup instructions, and include specific usage information.
You are also encouraged to set up your IDE with linting and formatting to ensure your commits can be merged.

### Vscode config

Install these extensions
Expand All @@ -38,8 +41,6 @@ Add these lines to your vscode workspace settings at `.vscode/settings.json`
"editor.defaultFormatter": "esbenp.prettier-vscode",
```

Each package has it's own readme with specific instructions.

## Release Process

[Release Please](https://github.com/googleapis/release-please) automates CHANGELOG generation, the creation of GitHub releases,
Expand Down

0 comments on commit 4def90c

Please sign in to comment.