Skip to content

Latest commit

 

History

History
103 lines (66 loc) · 2.91 KB

README-DEVELOPMENT.md

File metadata and controls

103 lines (66 loc) · 2.91 KB
Raw

@studiohyperdrive/logger v1.0.0

SHD logging module: an abstraction on console.log for both frontend as backend (Node.js).

Table of contents

Setup

System Dependencies

Init

This package consists of a codebase for both the browser and Node.js logger. Therefore dependencies can be installed and scripts can be executed in these subfolders.

  • npm start // Will install all dependencies for bundling the package.

browser

  • npm start // Will install the dependencies and build the browser logger.
  • npm run demo // Runs an example application using the browser logger.

nodejs

  • npm start // Will install the dependencies and build the Node.js logger.
  • npm run demo // Runs an example application using the Node.js logger.

Codebase

Structure

  • browser/: Contains the library code for the browser logger.
  • dist/: Contains the built bundles for this package.
  • nodejs/: Contains the library code for the Node.js logger.
  • scripts/: Contains the build and publish script for this package.

Dependencies

  • high-console: The browser logger's output mechanism is based on high-console.
  • signale: The Node.js logger outputs messages to the console using signale.
  • winston: The Node.js logger uses winston for transporting messages to the console and daily logfiles.

External Services

  • Slack: The Node.js logger has an option to emit error messages to a channel on your Slack workspace.

NPM Scripts

Command Description
start Install the dependencies and build the package.
build Build the package.
release Build and release the package.

All commands are executable by running npm run [COMMAND-NAME].

Code Contribution

Branches

We follow these naming conventions:

  • master: Production-ready code.
  • release/*: Snapshot of a release.
  • feature/*: For developing new features.
  • bugfix/*: For bugs that are logged during testing.
  • hotfix/*: Only for hotfixing critical bugs from the master-branch.

Project Context

This project is a Studio Hyperdrive team effort.

Details

  • Client: Studio Hyperdrive
  • Start: 01/10/2018

Team