OTP Heroku

OTP-Heroku is a sample API created using the 12-Factor-App methodology.

The design of this API has been documented in the following blog post ( in french)

Get Started

Pre-requisites

To build the API, you must install the following softwares:

• Install Maven
• Install Redis
• Install RabbitMQ

Build and Run

mvn clean install
mvn spring-boot:run

Test the API on Heroku

Important Notice

This server is used for testing and educational purpose only.

Email

We are using Mailgun as mail server for email delivery. This server sends emails only to addresses that have been whitelisted.

To whitelist a email address you'll like to use for testing the API:

• Create a new issue containing the email address you want to whitelist
• We will whitelist your email address within 24 hours.
• You'll receive a confirmation email to accept receiving email from the Mailgun.

SMS

We are using MTN SMS for SMS delivery. But SMS delivery doesn't work because the account we are using is not production ready.

Use the API

• Goto to the online API playgoung on Heroku

Links

• Conception d'un système de gestion de One Time Password sur le Cloud
• Guide simplifié des Twelve-Factor-Apps.
• Comment créer une Twelve-Factor-App avec Spring Boot, Heroku et Github