Skip to main content

AppHelper

The @churchapps/apphelper* packages provide shared React components and utilities for all ChurchApps web applications. AppHelper is structured as a workspace (monorepo) containing 6 packages.

Packages

PackageDescription
@churchapps/apphelperCore components and utilities
@churchapps/apphelper-loginLogin and registration UI
@churchapps/apphelper-donationsGiving and donation components
@churchapps/apphelper-formsForm builder components
@churchapps/apphelper-markdownMarkdown editor and renderer
@churchapps/apphelper-websiteWebsite and CMS components

Setup for Local Development

  1. Clone the repository:

    git clone https://github.com/ChurchApps/AppHelper.git
  2. Install dependencies:

    cd AppHelper && npm install
  3. Build all packages and launch the Vite playground:

    npm run playground:reload

    This builds every package in the workspace, then starts the playground dev server at http://localhost:3001.

tip

The playground is the fastest way to develop and test AppHelper components. It hot-reloads the Vite dev server so you can see changes in real time.

Publishing

Publish a single package:

npm run publish:apphelper

Publish all packages:

npm run publish:all
warning

When publishing, make sure to update the version number in the relevant package.json file(s) before running the publish command. All packages that depend on a changed package should also be updated.