carlos-new-cerebr-search-app
v0.1.0
Published
> It is boilerplate to create plugins for [Cerebro app](http://www.cerebroapp.com)
Downloads
5
Readme
Cerebro Plugin
It is boilerplate to create plugins for Cerebro app
Usage
- Clone this repo to your machine;
- Edit
package.json
–name
,description
,author
andrepository
fields; - Run
npm install
– you are ready to build your plugin!
Debugging your plugin
- Open Cerebro app;
- Enter
settings
and open preview for Cerebro Settings; - Turn on developer mode;
- Now you have development submenu in tray menu. Choose reload and DevTools (main) to open developer tools.
Put your plugin directory to ~/Library/Application\ Support/Cerebro/plugins/
. Easiest way to do it is to use symbolic links with built-in command:
npm run debug
On windows use cygwin or git bash instead of cmd.exe and
./scripts/debug
command instead ofnpm run debug
. If you choose to use cmd.exe, usenpm run debug:windows
Or if you running Cerebro from source code:
npm run debug -- dev
Or in cmd.exe
npm run debug:windows dev
Documentation
Use Cerebro documentation for plugins.
Related
- Cerebro – main repo for Cerebro app;
- cerebro tools – package with tools to simplify package creation;
License
MIT © Alexandr Subbotin