df-starter-kit
Tooling to help teams QUICKLY build conversational experiencesNote: For the very impatient, go here: quickstart.md
If you're new to conversational interfaces/agents, you might want to start with the:
Overview
Designing and building conversational interfaces is a "team sport." To do it right (ie deliver something that is actually valuable to users ) requires the contributions of many different people from a variety of backgrounds and lots of fine-tuning based on feedback.
This repo and associated tooling are designed to make it fast and easy to experiment and make changes. With good tooling, teams can spend their limited time/resources on polishing their conversation-- not fiddling with infrastructure or implementation details.
Accordingly, this repo provides sane defaults & tooling for the following:
- A "starter" agent that orders ice cream
- server
- webhook
- frontend w/ rich components
- Tunneling for local development of fulfillment webhooks (connecting your agent to external services)
- Easy deployment w/ firebase
Commands
| Command | Function |
|---|---|
$ npm run install:all |
Installs dependencies |
$ npm run serve |
Starts live-reload process on port specified in config (default port 8000) |
$ npm run build |
Bundles codebase to dist/ directory |
$ npm run tunnel |
Tunnels server on port specified in settings (see here for security considerations) |
Deployment
In order to get up and running as quickly as possible with sane defaults, this repo provides several commands that make deploying a simple backend server, fulfillment webhook, and frontend using firebase funtions
| Command | Description |
|---|---|
$ npm run deploy:webhook |
Bundles webhook & create deploy/ directory (for easy deploy to Firebase) |
$ npm run deploy:backend |
Cretes deploy/ directory for a backend to transact w/ DialogFlow services (easy deploy to Firebase) |
$ npm run deploy:frontend |
Cretes deploy/ directory for a frontend from src/frontend/dist (easy deploy to Firebase) |