Skip to content

triamudomcmc/hazel

Repository files navigation

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

To start create a script, please take a look at cli documentation.

Hazel CLI

Hazel is now available as a CLI.

You can now access the framework mainly from behind the CLI. If you want to use hazel in your node project you can install the library again locally.

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

About

Hazel - Clubs Data Processing Framework

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published