@magic.batua/messaging
v2.0.0
Published
The Messaging modules powers the text messaging features of the Magic Batua platform.
Downloads
2
Readme
Magic-Messaging
Handles all the messaging needs of the Magic Batua platform.
How to work with this module
Clone the repository to your computer.
Add a file named
.env
at the root of the project. This should be a YAML file and have the following environment variables:SMS_Password
: Pinnacle account passwordSMS_SenderID
: Pinnacle account Sender ID. Is "DEMOOO" at the time of writing.SMS_Password
: Pinnacle account username
Open Terminal (Command Prompt on Windows),
cd
to the project folder and typenpm install
. This would install all the NPM dependencies for this project, and transpile the Typescript code to JavaScript. Don't close the Terminal window.Next, type the following in the Terminal window:
npm test
. This would run all the unit test that I've written for this particular module. If all tests pass, you've got a fully workingAccount
module in front you.To get a sense of the code structure, I'd recommend consulting the
Code Manual
. Code Manual is a local site that gets generated from the documentation comments I've left in the source code. To generateCode Manual
on your computer, open the Terminal,cd
to the project root and runnpm run code-manual
.You should now have a
Code Manual
folder at your project root. Open theindex.html
file in the folder in your favourite browser and enjoy the ride.Make sure you commit any changes made to the source code at regular intervals, and sync the changes back to the Bitbucket
origin
repository.
Contact
For queries, you can write to Animesh at [email protected]. Make sure you have read this before firing off a bug report.