Create Bottender App

Create Bottender apps with predefined configurations.

• Creating an App – How to create a new app.

Create Bottender App works on macOS, Windows, and Linux. If something doesn’t work, please file an issue. If you have questions or need help, please ask in our Discord community.

Quick Overview

npx create-bottender-app my-app
cd my-app
npm start -- --console

Creating an App

To create a new app, you may choose one of the following methods:

npx

npx create-bottender-app my-app

(npx is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions)

npm

npm init bottender-app my-app

npm init <initializer> is available in npm 6+

Yarn

yarn create bottender-app my-app

yarn create is available in Yarn 0.25+

It will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies:

my-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── .env
├── .env.example
├── bottender.config.js
├── index.js
└── src
    ├── index.test.js
    └── index.js

Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in production mode. By default, server runs on http://localhost:5000.

To run in Console Mode, provide the --console option:

npm start -- --console
yarn start --console

npm run dev or yarn dev

Runs the app in development mode. The bot will automatically reload if you make changes to the code. By default, server runs on http://localhost:5000 and ngrok runs on http://localhost:4040.

To run in Console Mode, provide the --console option:

npm run dev -- --console
yarn dev --console

npm run lint or yarn lint

Runs the linter rules using Eslint.

npm test or yarn test

Runs the test cases using Jest.

What’s Included?

Your environment will have everything you need to build a modern Bottender app:

• Bottender, ES6+ and TypeScript syntax support.
• A unit test runner - Jest with built-in support for coverage reporting.
• A JavaScript linter - Eslint with some predefined rules.
• A live development server that warns about common mistakes.