A phone messaging system
This project usese environment variables to work. For most cases, the
defaults work but some sensitive info like keys must be overridden. Copy
the file in
.env in the project root and override
When running with
make run, it'll pick up these values automatically.
If you're doing it the hard way, you'll have to source them. You must
DEAD_DROP_ACCOUNT_SID to match your account sid. This is so
dead drop can filter out calls from other accounts.
You'll need Docker to run the project.
- Run the image with
Running locally the hard way
If you don't want to use docker, you can also run it the old fashioned way.
- Install dependencies with
yarn install(recommended), or
- Run with
This project uses JSDoc to generate documentation. Generate everything
npm run document. The documentation will be generated in the
Building and pushing the image
You can also do some other operations
- Build the image with
- Push and build the image with
- Clean the environment with
Setting up Twilio
Get a twilio number, and on the configuration set the voice settings to
"Webhooks/TwiML" and point the
A call comes in hook to:
/menus/main/ path of your dead drop installation. For example:
https://dead-drop.unlimited.piza/menus/main. It must be accessible
from the internet.
You will also need your account sid. This is obtained from the "Account Settings" area in the twilio dashboard.
Checking the code
This project uses the Hapi Style Guide for
npm run lint to check the code.