TypeScript Logging adapter

An interface package for a logging factory with adapters for different logging libraries.
Currently supported logging libraries:

• Winston

Getting Started

Before you begin, ensure you have Node.js and npm installed on your machine.

Prerequisites

• Node.js 14.x or later
• npm 6.x or later

Installing

Clone the repository to your local machine:

git clone https://github.com/AroenvR/logscribe

Navigate into the directory:

cd logscribe

Install the dependencies:

npm i

Rename example.env to .env

Running the application

To run the application:

npm start

To run the application's tests:

npm run test

Features

• Preconfigured TypeScript for static typing in JavaScript
• ESLint for linting, with a custom configuration
• Nodemon for automatically restarting your application when file changes are detected
• Basic structure for a Node.js project

Project Structure

• src/: The source files of the application
• src/__tests__/: The testing directory
• coverage/: A detailed testing coverage report
• dist/: The transpiled code that is used for production
• node_modules/: The installed npm dependencies (do not modify)
• tsconfig.json: The TypeScript compiler options
• .gitignore: An index of files & directories which git should ignore
• .npmignore: An index of files & directories which npm should ignore when publishing a package
• .prettierrc: A prettier configuration file for formatting code with the npm run format script
• jest.config.js: A configuration file for the jest testing library
• .eslintrc.json: ESLint rules
• .eslintignore: Files to be ignored by ESLint
• package.json: npm package manager file, lists project information and dependencies
• nodemon.json: Nodemon configuration file

Built With

• Node.js - JavaScript runtime
• TypeScript - Typed JavaScript
• ESLint - Linter for JavaScript and TypeScript
• Nodemon - Utility to automatically restart node applications

License

This project is licensed under the MIT License - see the LICENSE file for details