https://github.com/botpress/studio
The studio is the main interface you'll use to build and edit your chatbot.
https://github.com/botpress/studio
Last synced: about 1 year ago
JSON representation
The studio is the main interface you'll use to build and edit your chatbot.
- Host: GitHub
- URL: https://github.com/botpress/studio
- Owner: botpress
- Created: 2021-05-19T15:08:20.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T22:46:17.000Z (about 2 years ago)
- Last Synced: 2025-03-21T21:11:32.085Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://botpress.com/docs/quickstart#conversation-studio
- Size: 9.63 MB
- Stars: 40
- Watchers: 9
- Forks: 42
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Development workflow
Currently, it is not recommended to run the studio on its own. Therefore, you must start the Botpress Server, which will provide a couple of required parameters so the studio can work smoothly with the server.
We use Yarn v3 in this repository, so if you have errors while trying to build the repository, ensure you have the latest version installed: `npm install -g yarn`
- Type `yarn`
- Build everything using `yarn build`
- Use `yarn watch` to start a watcher on both the backend and frontend
- Type `yarn package` to generate a single executable file for every available OS
Like before, any changes made on the frontend will be available after a simple page refresh. Changes on the backend will require a server restart.
Since this package MUST be started from the Botpress Server, you need to set a special environment variable on the server so it can load the correct files.
The variable is named `DEV_STUDIO_PATH` and must point to `packages/studio-be/out`. Watch out, path must be an abs path, env var doesn't support relative path.
## As standalone (NOT RECOMMENDED)
The studio can be executed as a standalone application, but there are still a couple of things that will not work correctly.
When started as a standalone, these environment variables must be set:
- BP_MODULES_PATH: Path to the modules folder of a Botpress installation
- BP_DATA_FOLDER: Path to the data folder (bots/, global/)
- BP_SERVER_URL: to determine
## Release workflow
1. Type `yarn release ` where type can be major, minor or patch
2. Open a PR with all the files, when it is merged on baster, binaries will be produced and released