Pre-load dotenv to properly load db env variables

benpbolton commented 1 year ago

Minor update to README for UX.

Description

Adding a NODE_OPTIONS preface to the command to pre-load dotenv

Motivation and Context

When a user specifies custom database parameters in .env, these are not currently loaded during an npm run db:migrate. Pre-loading dotenv through the NODE_OPTIONS is a low-lift one-line option to assist someone walking step-by-step through the instructions.

How Has This Been Tested?

Personal experience:)

Screenshots (if appropriate):

Types of changes

[x] Non-functional change (docs, style, minor refactor)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[ ] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my code changes.
[x] All new and existing tests passed.

benpbolton commented 1 year ago

Happy to close this if it's undesirable to leverage the existing dotenv stuffs, even the npm run start standalone instruction could potentially benefit from this.

cameri commented 1 year ago

Hi thanks for your contribution! Could you please update your commit message so it complies with Conventional Commits? it's failing because it's missing a prefix: https://www.conventionalcommits.org/en/v1.0.0/#summary

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 1.22.5 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

cameri / nostream