@magic.batua/recharge/Readme.md

The Recharge module manages all the mobile prepaid, datacard and DTH recharge functionalities of the Magic Batua platform.

# Magic-Recharge

The `Rechage` module powering Magic API platform.

## How to work with this module

1.  Clone the repository to your computer.

2.  Add a file named `.env` at the root of the project. This should be a YAML file and have the
    following environment variables:
    * `RIP_MerchantID`: Rocket in Pocket's client ID
    * `RIP_MerchantKey`: Rocket in Pocket client key. This is bound to a single IP.
    * `RIP_RechargeURL`: Base URL for Rocket in Pocket's Recharge API.

3.  Open Terminal (Command Prompt on Windows), `cd` to the project folder and type `npm install`.
    This would install all the NPM dependencies for this project, and transpile the Typescript
    code to JavaScript. Don't close the Terminal window.

4.  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 working
    `Recharge` module in front you.

5.  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 generate `Code Manual` on your computer, open the Terminal, `cd` to the project root and run 
    `npm run code-manual`.
    
6.  You should now have a `Code Manual` folder at your project root. Open the `index.html` file in
    the folder in your favourite browser and enjoy the ride.

7.  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 [hello@animesh.ltd](mailto:hello@animesh.ltd). Make sure
you have read [this](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) before firing off a
bug report.