beamkenya / at_sample_app

AtSampleApp is a sample web application with Plug.Router that has sample usecases of different existing functionalities in the africastalking elixir wrapper

AtSampleApp

Introduction

AtSampleApp is a sample web application with Plug.Router that has sample usecases of different existing functionalities in the africastalking elixir wrapper. Developers can use this to get a better understanding of how the wapper works and/or test these intergrations locally.

Africastalking elixir wrapper has already been added as dependency in the mix.exs .

This application will guide developers on how the elixir wrapper functionalities can be used. It shall be updated with functionalities from the wrapper that are ready for consuming.

Table of Contents

1. Build Set up
2. How to get started
3. Roadmap and coverage
4. Use Cases
5. How to contribute
6. Community
7. Contributers
8. Licence

Build set up

Install dependencies with mix deps.get

Run the server with mix run --no-halt. And access it at localhost:4001

Run the app iex -S mix

Or run mix run --no-halt for the web then visit http://localhost:4001

How to get started

To start developing, you will need the following

• elixir > 1.8.0 installed in your computer.
• Go to Africas Talking to register for an account
• Check AtEx for configuration and set up instructions

Roadmap and coverage

Here are the main functionalities included in which are inlcuded in this app, the plan is to cover the usecases all the functionalities within the wrapper. You can contribute by adding more, check out the Contribution Guide

• SMS
• USSD
• Voice
• Airtime
• Payments
• IoT
• Application

Use Cases

USSD

For more info about serice codes, check Africastalking Service Codes.

USSD urls ar available on /ussd/simple and /ussd/advanced for simple and comples USSD usecases respectively.

You can use Ngrok to expose your localhost urls

SMS

Voice

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.If you don't see your idea listed, Open an issue check the Contribution guide

Community

Discussions about the Library take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.

Contributors

Auto-populated from: contributors-img

Licence

Apache 2 Licence