ProPresenter Nursery Messages

This application provides a simple and effective way to display nursery messages in ProPresenter. It connects to the ProPresenter API to fetch and trigger messages, making it easy for volunteers and staff to manage nursery alerts without needing to access the main ProPresenter interface.

Features

• Connect to ProPresenter Remotely: Enter the network address of your ProPresenter instance to connect to it.
• View Available Messages: The application will list all available messages from your ProPresenter setup.
• Fill in Message Tokens: If a message contains tokens (e.g., for a child's name or number), you can easily fill them in before displaying the message.
• Real-time Updates: The message list automatically refreshes every second, so you always have the most up-to-date information.
• Localized Interface: The user interface is available in multiple languages including English, German, Spanish, French, Portuguese, Korean, Norwegian, Czech, Simplified Chinese, Russian, Hindi, Arabic, and Bengali. The application automatically detects your browser's language.

How to Use

This section is for end-users who will be operating the application.

1. Open the application in your web browser.
2. Enter the network address for your ProPresenter instance in the input field (e.g., http://localhost:1025).
3. The application will automatically fetch and display a list of available messages.
4. For any message, fill in the required token values in the provided input fields.
5. Click the "Show" button to trigger the message in ProPresenter.

How to Run and Deploy for Developers

This section is for developers who want to run the application locally or deploy it to a web server.

Running in a Development Environment

To run this application locally for development, you will need to have Node.js and npm installed.

1. Clone the repository to your local machine.
2. Install the dependencies by running the following command in the project's root directory:

   npm install

3. Start the development server with the following command:

   npm run dev

4. Open your web browser and navigate to the local address provided by Vite (usually http://localhost:5173).

Deploying to a Static Web Server

To deploy this application, you first need to build the static assets.

1. Build the application by running the following command in the project's root directory:

   npm run build

   This command will create a dist directory containing the optimized static files for your application (HTML, CSS, and JavaScript).

2. Host the dist directory with any static web server. A simple option is the static-web-server tool.

   • You can find instructions on how to set up static-web-server in their official documentation: Static Web Server - Getting Started

Once you have your web server set up, configure it to serve the files from the dist directory.

Releases

This project uses automated releases via GitHub Actions. When a new version tag is pushed to the repository, the build pipeline automatically:

1. Builds the application
2. Creates a release archive containing all static files
3. Creates a GitHub Release with the version number
4. Uploads the build artifacts to the release

Creating a New Release

To create a new release, maintainers should:

1. Update the version number in package.json if needed
2. Create and push a version tag:

   git tag v1.0.0
   git push origin v1.0.0

3. The GitHub Actions workflow will automatically build and create the release

Downloading Releases

Users can download pre-built releases from the Releases page. Each release includes a ZIP file with all necessary files to deploy the application.

License

This project is licensed under the MIT License - see the LICENSE file for details.