Skip to content

Commit c461b30

Browse files
feat: added logging info in README.md
1 parent eeeeec3 commit c461b30

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# Node.js project with TypeScript, Express.js, ESLint, Prettier, ts-node, nodemon and package.json environment specific scripts
1+
# Node.js project with TypeScript, Express.js, ESLint, Prettier, ts-node, nodemon, package.json, environment specific scripts, Logging and Logrotate automation
22

3-
## #[typescript-node-project](https://shubhamsharmas.hashnode.dev/a-guide-on-setting-up-a-nodejs-project-with-typescript-expressjs-eslint-prettier-ts-node-nodemon-and-packagejson-environment-specific-scripts "https://shubhamsharmas.hashnode.dev/a-guide-on-setting-up-a-nodejs-project-with-typescript-expressjs-eslint-prettier-ts-node-nodemon-and-packagejson-environment-specific-scripts")
3+
## #[typescript-node-project-with-logging](https://shubhamsharmas.hashnode.dev/setting-up-logging-in-your-nodejs-typescript-app-a-quick-start-guide-with-typescript-node-project-and-pino-logging-libraryintegrated-with-logrotate)
44

55
Welcome to the TypeScript Node.js project! This repository provides complete guide on setting-up a Node.js project with TypeScript, Express.js, ESLint, Prettier, ts-node, nodemon, and environment-specific package.json scripts for local, development, QA, and production.
66

7+
> This branch feature/pino-logging contains additional pino logging and logrotate functionality on the top of existing [typescript-node-project](https://shubhamsharmas.hashnode.dev/a-guide-on-setting-up-a-nodejs-project-with-typescript-expressjs-eslint-prettier-ts-node-nodemon-and-packagejson-environment-specific-scripts)
8+
79
## Technologies & Tools Used
810

911
1. **Node.js**: The project is built using Node.js, allowing users to leverage the benefits of server-side JavaScript.
@@ -34,6 +36,10 @@ Welcome to the TypeScript Node.js project! This repository provides complete gui
3436

3537
14. **Linting and Formatting Scripts**: Provides environment-specific scripts in the `package.json` for linting and formatting code using ESLint and Prettier.
3638

39+
15. **Pino Logger**: Efficient logging for Node.js applications with Pino.
40+
16. **Logrotate**: Automated log rotation for managing log files.
41+
17. **Logrotate CRON Automation**: Schedule Logrotate tasks for seamless log file rotation in your system.
42+
3743
## Project Setup
3844

3945
Follow the steps below to set up the project on your local system:
@@ -63,4 +69,6 @@ Follow the steps below to set up the project on your local system:
6369
"prod": "NODE_ENV=production npm run build:start"
6470
```
6571

72+
## Check the link for pino logging, logrotate details and it's code walk-through: [typescript-node-project-with-logging](https://shubhamsharmas.hashnode.dev/setting-up-logging-in-your-nodejs-typescript-app-a-quick-start-guide-with-typescript-node-project-and-pino-logging-libraryintegrated-with-logrotate)
73+
6674
## Check the link for complete project details and code walk-through: [node.js-typescript-project-setup](https://shubhamsharmas.hashnode.dev/a-guide-on-setting-up-a-nodejs-project-with-typescript-expressjs-eslint-prettier-ts-node-nodemon-and-packagejson-environment-specific-scripts)

0 commit comments

Comments
 (0)