@tucmc/hazel

Hazel—Clubs Data Processing Framework

Use Hazel to deal with complex data without hustle.

Prerequisite

Current built-in data source is Firebase Firestore. To establish the connection .env is required with the format as shown below.

.env File

FCERT_CLIENT_EMAIL=
FCERT_PROJECT_ID=
FCERT_PRIVATE_KEY=

Important note

Default exported data directory is ./resource, which git ignored by default. To avoid accidentally exposing any data, this directory should not be added to the public repository.

Installation

Install the package globally using any package manager.

npm install --global @tucmc/hazel
yarn add -G @tucmc/hazel

Some examples can be found here.
🗒️ Examples

Hazel CLI

Hazel is also available as a CLI.

Try using

hazel --help

CLI can be used to run or init single-file hazel script without the creation of node project.

Further documentation about Hazel CLI can be found here. CLI Documentation

Documentation

Library documentation can be found here.
Documentation is here :)

Made with ♥ by TUCMC

Changelog

[0.0.1] - 2024-04-15

Added

• CLI support for basic command <br/> (more detail at CLI's documentation)

  ReferableMapEntity<T>

  • ReferableMapEntity.<b>synthesized</b> attribute for determining whether the object is newly created in script or retrieved from the existing source.<br/><br/> (in-script created ReferableMapEntity will always be marked as synthesized and will be created when push to the database)

  Runtime

  • Runtime options can be now configure through process environment

Changed

• Testing script changed from run to exec. You may use yarn run exec instead.

Fixed

• Improper Collection data fetching sequence.