Skip to content

fix documentation for running locally #84

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

Merged
voj merged 2 commits into from
Mar 23, 2026
Merged

fix documentation for running locally #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c0b267
fix documentation for running locally
voj Mar 23, 2026
cd14539
fix paths
voj Mar 23, 2026
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,23 @@ poetry lock
poetry shell
```

Make sure the dynamob plugin for local tests is installed
Make sure the dynamodb plugin for local tests is installed
```
yarn sls dynamodb install
```

### Run full stack locally

```
# npx serverless dynamodb start --stage local &\
# npx serverless s3 start &\
npx serverless dynamodb start --stage local &\
npx serverless s3 start &\
SLS_OFFLINE=1 poetry run yarn sls wsgi serve
```

then

```
AWS_PROFILE=*** SLS_OFFLINE=1 poetry run cli WORKING/NSHM_v1.0.4_CompositeSolution.zip NSHM_v1.0.4 -R --ensure_table
AWS_PROFILE=*** SLS_OFFLINE=1 poetry run python ./solvis_graphql_api/scripts/cli.py WORKING/NSHM_v1.0.4_CompositeSolution.zip NSHM_v1.0.4 -R --ensure_table
```

### Unit tests
Expand All @@ -60,5 +60,5 @@ AWS_PROFILE=*** SLS_OFFLINE=1 poetry run cli WORKING/NSHM_v1.0.4_CompositeSoluti
### Push a composite solution

```
AWS_PROFILE=*** REGION=ap-southeast-4 DEPLOYMENT_STAGE=dev S3_BUCKET_NAME=nzshm22-solvis-graphql-api-dev cli WORKING/NSHM_v1.0.4_CompositeSolution.zip NSHM_v1.0.4 -R
```
AWS_PROFILE=*** REGION=ap-southeast-4 DEPLOYMENT_STAGE=dev S3_BUCKET_NAME=nzshm22-solvis-graphql-api-dev poetry run python ./solvis_graphql_api/scripts/cli.py WORKING/NSHM_v1.0.4_CompositeSolution.zip NSHM_v1.0.4 -R
```
2 changes: 2 additions & 0 deletions serverless.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ configValidationMode: error
plugins:
- serverless-wsgi
- serverless-plugin-warmup
- serverless-dynamodb
- serverless-s3-local

package:
individually: false
Expand Down
Loading