Skip to content

feat: add Docker support and update README with usage instructions#21

Open
moabdelazem wants to merge 1 commit into
husamql3:stagefrom
moabdelazem:stage
Open

feat: add Docker support and update README with usage instructions#21
moabdelazem wants to merge 1 commit into
husamql3:stagefrom
moabdelazem:stage

Conversation

@moabdelazem
Copy link
Copy Markdown

This pull request introduces Docker support for the project, enabling users to build and run the application in a containerized environment. It adds a production-ready Dockerfile, a comprehensive .dockerignore to optimize image builds, and updates the README.md with clear instructions and usage examples for Docker. These changes make it easier to use and distribute the application without requiring local installation of dependencies.

Docker support and configuration:

  • Added a multi-stage Dockerfile that builds the application using Bun, installs dependencies, builds workspace packages, and creates a minimal production image with a global hviz entrypoint.
  • Introduced a .dockerignore file to exclude unnecessary files and directories from Docker builds, improving build performance and reducing image size.

Documentation updates:

  • Updated README.md to include Docker usage instructions, including build and run commands, port mapping, and volume mounting for different ORMs. [1] [2]
  • Added a quick example in the README.md for running the application via Docker without installation.

@moabdelazem moabdelazem requested a review from husamql3 as a code owner October 23, 2025 19:04
@moabdelazem
Copy link
Copy Markdown
Author

#19

@husamql3
Copy link
Copy Markdown
Owner

Great work, @moabdelazem ❤️
I appreciate your contribution a lot here

But I'm wondering, why would we have a docker here!
It's supposed to be an npm pkg so it should be compatible with all environments

What do you think?

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