Skip to main content

Helpers

The @churchapps/helpers package provides base utilities used by all ChurchApps projects, both frontend and backend. It is framework-agnostic and includes common helpers such as DateHelper, ApiHelper, and other shared utilities.

Setup for Local Development

  1. Clone the repository:

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

    cd Helpers && npm install
  3. Build the package (compiles TypeScript to dist/):

    npm run build
  4. Make it available for local linking:

    npm link

You can then link it into any consuming project:

cd ../YourProject && npm link @churchapps/helpers

Publishing

To publish a new version to npm:

  1. Update the version in package.json

  2. Publish:

    npm publish --access=public
note

Since this package is used by every ChurchApps project, changes here have a wide impact. Test thoroughly with npm link in at least one consuming API and one consuming web app before publishing.