Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 1.93 KB

README.md

File metadata and controls

76 lines (47 loc) · 1.93 KB
Raw

Django Alexa Template

This is a Alexa skill boilerplate using Django project as local web service and ngrok to expose the local server behind NATs and firewalls to the public internet over secure tunnels.

Documentation

Basic requirements

  • ngrok and ask-cli must be installed before initializing the project.

  • cookiecutter is required to clone this boilerplate.

  • also virtualenv is required, to prepare the virtual environment used by Django

Initialization

Use cookiecutter to clone the boilerplate:

$ cookiecutter https://github.com/20tab/django-alexa-template

Usage

First of all you have to expose your local web server to a public url, using ngrok:

$ ngrok http 8000

Then

$ cd <skill_dirname>

After this run command to deploy and test your skill using your local web server.

To run without deploy your skill:

$ make run

If skill changes you need to deploy it. To simplify this process you can use:

$ make run d=--deploy

NOTE: "make run" command is simply a wrapper using python and ask-cli commands.

In every case the terminal will show django runserver logs:

Performing system checks...

System check identified no issues (0 silenced).
September 05, 2019 - 11:15:11
Django version 2.2.5, using settings 'myskill.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

To run test on your web service, just launch the following command:

$ make test