Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom startup console messages #52

Closed
hwgilbert16 opened this issue Aug 23, 2023 · 1 comment
Closed

Custom startup console messages #52

hwgilbert16 opened this issue Aug 23, 2023 · 1 comment
Assignees
Labels
upcoming feature This feature has been accepted and will be worked on

Comments

@hwgilbert16
Copy link
Owner

hwgilbert16 commented Aug 23, 2023

The current messaging during startup is useful for development debugging, but it can be unintuitive for non-developer users attempting to troubleshoot their own install.

Nest serves Angular and Docusaurus as static files, so nothing needs to be modified with those applications. Only NestJS needs to have its default logging disabled in production. However, if NODE_ENV is development, we should leave the console messaging as it is right now.

Logging should be kept to a minimal. Likely, all that needs to be logged is when the application is starting, once it is finished, and any errors if they occur. If there's other situations when you feel a log is necessary, then feel free to add them. Errors can be logged as-is to the console. Colors can be used if they improve the experience - something like Scholarsome - [console message], with Scholarsome in purple.

I've provided a couple links below. For the implementation, I recommend implementing a custom logger service and using Winston as the logger, but you're welcome to use another logger or implementation if it works better.

Resources:

https://docs.nestjs.com/techniques/logger
https://www.npmjs.com/package/winston

@hwgilbert16 hwgilbert16 added the upcoming feature This feature has been accepted and will be worked on label Aug 23, 2023
hwgilbert16 added a commit that referenced this issue Aug 31, 2023
#52 "Logger - set up completed"
@hwgilbert16
Copy link
Owner Author

Added in #53

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
upcoming feature This feature has been accepted and will be worked on
Projects
Development

No branches or pull requests

2 participants