https://github.com/botpress/quick-start-module
A module template to help you get started
https://github.com/botpress/quick-start-module
Last synced: about 1 year ago
JSON representation
A module template to help you get started
- Host: GitHub
- URL: https://github.com/botpress/quick-start-module
- Owner: botpress
- Created: 2018-11-09T22:49:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-09T23:26:11.000Z (over 7 years ago)
- Last Synced: 2025-02-15T14:47:35.516Z (over 1 year ago)
- Language: TypeScript
- Size: 76.2 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quick Start Module
This is a module template to help you get started coding your own module. Please refer to the [_Developer's Guide_](https://botpress.io/docs/latest/docs/modules/install) to learn more about _Botpress Modules_.
## How to install
- **clone**: `cd modules/ && git clone git@github.com:botpress/quick-start-module.git`
- **zip**: Download the zip and move it under the `modules/` folder.
1. Add the module to `src/templates/data/global/botpress.config.json` under `modules`:
```json
{
"location": "MODULES_ROOT/quick-start-module",
"enabled": true
}
```
2. Run `yarn build` in botpress root.
1. Run `yarn start` and you should see an hint in your logs that it worked 😉