raguay/bulletinboard

This is a simple program to display messages to the user and get responses back. It is used to make dialogs for scripts or simply post information to be seen.

BulletinBoard

BulletinBoard is a program for showing information and dialogs to the user. Scripts can use it to get information from the user. It is used by the EmailIt program to ask information from the user for filling in a template. Custom dialogs are easily created using the cli dialog builder.

This is a Wails 2 version of my original BulletinBoard-NWJS project. I use this program everyday in my workflow. I'm hopeful that you will find it useful as well. You can discuss about this program in the discussions board.

Table of Contents

• How to Build
• Using BulletinBoard
• Articles about BulletinBoard

How to build

You have to have node.js, go, and Wails 2 installed first. To build it, type:

wails build

To build as a macOS universal bundle, you type:

wails build --platform "darwin/universal"

Or, install the mask script runner and use the maskfile.md in this directory by typing:

mask build

The mask script file will also package the default dialogs for the user to use. If you use the wails build command to make the binary, you would need to copy the ./dialogs directory contents to your ~/.config/bulletinboard/dialogs directory to use them.

The executable file will be created in the build/bin directory.

To run the development environment, you type:

wails dev

Alternatively, you can install and use the builds in the releases page. I've only used this program on a macOS system, but it should build and run okay on other OSes. I hopefully will make some builds for Windows and Linux soon.

Using BulletinBoard

The first thing to be done is to create a command line alias to the main program in order to use the command line interface. To do that, add the following for the shell config file of your shell:

alias bb="/Applications/BulletinBoard.app/Contents/macOS/BulletinBoard"

Now you can use it in the command line with bb. Be careful not to use the command line without any arguments as that will run the gui Application. If you run bb help you will get the list of supported commands.

Using bb build <name>, where <name> is the name of the template, you will be given the template builder shown above in the introduction. bb deleteTemplate <name> will delete the given template. bb list will list all the templates both given with the program and the user defined templates. bb send message <message> will send the <message> in quotes to the bulletinboard program to display to the user just the message. bb send template <name> will send the <name> template to the BulletinBoard program to show the user. When the user presses a cancel button, the cancel button is given in the json return structure. If a button with the submit command will return all the input type elements with their values in a json structure. This allows BublletinBoard to be used by other programs to get information from the user.

Articles about BulletinBoard

• Building Bulletin Board
• Adding a Bubbletea CLI Interface

bulletinboard's Issues

wails dev/build fails on clean cloned copy

Just clone this repo but cannot use.

Wails complains that frontend/dist is missing

... and it's true ...