Cadoles/fake-sms
Cadoles
/
fake-sms
21
0
Fork 0
Code Issues 2 Pull Requests 3 Releases Wiki Activity
Serveur d’envoi de SMS factice pour le développement avec interface web
10 Commits 7 Branches 12 Tags 741 KiB
Go 80.2%
JavaScript 9.2%
Shell 5.6%
Makefile 2.4%
Dockerfile 1.5%
Other 1.1%
Go to file
wpetit eb9f19eaa0 Normalize links in templates 2021-01-22 11:42:03 +01:00
cmd/fake-sms Normalize links in templates 2021-01-22 11:42:03 +01:00
internal Add BaseURL config parameter 2021-01-15 16:47:28 +01:00
misc Add Iroquois/Powow API mocking entrypoint 2020-12-22 15:00:42 +01:00
.dockerignore Initial commit 2020-12-21 15:59:07 +01:00
.env.dist Initial commit 2020-12-21 15:59:07 +01:00
.gitignore Add Iroquois/Powow API mocking entrypoint 2020-12-22 15:00:42 +01:00
LICENCE Initial commit 2020-12-21 15:59:07 +01:00
Makefile Transfer Docker image ownership to Cadoles 2020-12-22 15:47:42 +01:00
README.md Transfer Docker image ownership to Cadoles 2020-12-22 15:47:42 +01:00
go.mod Initial commit 2020-12-21 15:59:07 +01:00
go.sum Initial commit 2020-12-21 15:59:07 +01:00
modd.conf Initial commit 2020-12-21 15:59:07 +01:00
package-lock.json Fix package-lock.json project name 2020-12-22 15:19:42 +01:00
package.json Initial commit 2020-12-21 15:59:07 +01:00
webpack.config.js Initial commit 2020-12-21 15:59:07 +01:00

README.md

📱 FakeSMS

Serveur d'envoi de SMS factice pour le développement avec interface web.

Utilisation

Avec Docker

docker run -it --rm -p 3000:3000 cadoles/fake-sms

L'interface Web sera accessible à l'adresse http://localhost:3000/.

Voir la section "Variables d'environnement" pour voir comment personnaliser la configuration du service.

Avec les binaires

TODO

Configuration

Le fichier de configuration de FakeSMTP est au format YAML.

Voici la structure du fichier par défaut:

# Configuration HTTP
http:
  address: :3000
  templateDir: template
  publicDir: public
# Configuration du stockage
data:
  path: fakesms.db

# Confirguration du mock Powow
# Voir https://powow4.iroquois.fr/
powow:
  # Clé d'API à utiliser par les clients Powow utilisant le mock
  apiKey: powow

  # Modèles de SMS transactionnels
  # Voir https://powow4.iroquois.fr/user/docs/api/#create-transactional-sms
  # et https://powow4.iroquois.fr/user/docs/api/#update-transactional-sms
  #
  # L'identifiant (SmsID) de chaque modèle est son index dans le tableau.
  sms:
  - name: Powow SMS
    from: FakeSMS
    # Modèle de contenu pour le SMS avec patrons d'insertion
    # Voir https://powow4.iroquois.fr/user/docs/api/#send-transactional-sms, "About the CustomData parameter"
    content: |
      Bonjour %Subscriber:Firstname%,

      Lorem ipsum dolor sit amet...      
    # Cet attribut n'est pas utilisé dans le cadre du mock
    shortLink: false

Variables d'environnement

La configuration de FakeSMTP peut être personnalisée via des variables d'environnement.

Les valeurs des variables d'environnement surchargent les valeurs présentes dans le fichier de configuration.

Variable Correspondance dans le fichier de configuration
FAKESMS_HTTP_ADDRESS http.address
FAKESMS_HTTP_TEMPLATEDIR http.templateDir
FAKESMS_HTTP_PUBLICDIR http.publicDir
FAKESMS_POWOW_API_KEY powow.apiKey

Mocks

Iroquois/Powow

Un mock de l'API Powow est disponible via l'URL http://<fake_sms_host>/api/v1/mock/powow.

Les commandes suivantes sont implémentées:

Commande Documentation officiele Notes
TransactionalSms.Send https://powow4.iroquois.fr/user/docs/api/#send-transactional-sms La définition des modèles de SMS s'effectue via la configuration.

Un exemple d'appel à l'API est disponible dans le fichier misc/powow.http.

Démarrer avec les sources

Dépendances

  • Go 1.13
  • modd
  • make
  • NodeJS/npm

Compiler et démarrer le serveur de développement

Dans un terminal:

npm install
make watch

FAQ

Générer une version de distribution

make release

Licence

AGPL-3.0