Files
notifications-api/docs/localstack.md

45 lines
1.4 KiB
Markdown
Raw Normal View History

2023-08-29 13:12:18 -07:00
How to Use Localstack in Your Development Work
==================================
### Install Docker Desktop (One-Time)
* https://docs.docker.com/desktop/install/mac-install/
### Install Localstack (One-Time)
* >pip install --upgrade localstack
* >localstack --version # should be 2.2.0 or later
2023-08-29 13:12:18 -07:00
### Add LOCALSTACK_ENDPOINT_URL to Your .env File (One-Time)
2023-11-17 09:47:32 -05:00
* Find the value in the sample.env file (# LOCALSTACK_ENDPOINT_URL=http://localhost:4566).
* Copy and uncomment it into your .env file
2023-08-29 13:12:18 -07:00
### Run with Localstack (Recurring)
#### Start Docker Desktop and localstack image
* Open Docker Desktop from Finder
* Images->Local->localstack/localstack click on the start button on the right hand side to get the localstack
docker image going
2023-08-29 13:12:18 -07:00
#### Start Localstack
* From your project directory in a separate terminal window, either:
* >localstack start
* >pipenv run localstack start
#### Proceed With Your Usual Development Activities
2023-08-29 13:12:18 -07:00
Assuming you followed all these steps and nothing went wrong, you should be running with localstack for SNS now.
You should be able to send an SMS message in the UI and observe it in the dashboard moving from Pending to Delivered
over a period of five minutes. And you should not receive a text message.
NOTE: You will still be prompted for a 2FA code when you log in. To get the code, look in the notification-api
2023-11-17 09:47:32 -05:00
logs for "AUTHENTICATION_CODE:".