1.0.11 • Published 1 year ago
ts-log-adapter v1.0.11
TypeScript Logging adapter
An interface package for a logging factory with adapters for different logging libraries.
Currently supported logging libraries:
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/logscribeNavigate into the directory:
cd logscribeInstall the dependencies:
npm iRename example.env to .env
Running the application
To run the application:
npm startTo run the application's tests:
npm run testFeatures
- 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 applicationsrc/__tests__/: The testing directorycoverage/: A detailed testing coverage reportdist/: The transpiled code that is used for productionnode_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: Aprettierconfiguration file for formatting code with thenpm run formatscriptjest.config.js: A configuration file for thejesttesting library.eslintrc.json: ESLint rules.eslintignore: Files to be ignored by ESLintpackage.json: npm package manager file, lists project information and dependenciesnodemon.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