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

Migrate util lib to util Monorepo #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jacob-ling-aligent
Copy link

  • PR for conversion of Repo to use NX monorepo.
  • This was done using the default nx lib generator.
  • Not sure what the standard is in terms of how the libraries should be set up with ESM/CommonJS etc.

Copy link

@kai-nguyen-aligent kai-nguyen-aligent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jacob-ling-aligent ,
As far as I can remember, the original lib utils is a single NPM package that contains 3 things:

  • S3 utilities
  • SSM utilities
  • Retry wrapper

With this set-up, would it be possible for us to publish to NPM? If yes, would it be a single package or multiple packages?

I also would like to see more info in the ReadMe files. These libraries will be consumed (and maintained) by other developers so we also need to have guidelines on consuming and contributing. I think we need:

  • A ReadMe file at root level that at least has brief description about what is in this repository; Installation, Usage and Development instructions.
  • A ReadMe file for each package which contains Installation and Usage instructions for the package.

I'm open for a chat to discuss further on these. Please just chuck an invitation into my calendar if you would like to chat.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants