Skip to content

Commit

Permalink
#297 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TWilkin committed Aug 6, 2023
1 parent 04cff88 commit 050840e
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions services/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,19 @@ This service requires two configuration files, both of which are described on th

## Testing

There are currently no automated tests for this service.
This service can be tested by executing the following commands.

```bash
# From the root of your PowerPi checkout
# Download the dependencies
yarn

# Build the common libraries
yarn build:lib

# Run the service locally
yarn test:api
```

## Local Execution

Expand All @@ -55,9 +67,8 @@ The service can be started locally with the following commands.
# Download the dependencies
yarn

# Build the api and common library
yarn build:common
yarn build:common-api
# Build the common libraries
yarn build:lib

# Run the service locally
yarn start:api
Expand Down

0 comments on commit 050840e

Please sign in to comment.