@zodiac3k/dockerize-cli
v0.0.69-alpha
Published
A CLI tool for setting up Dockerized applications with customizable options.
Downloads
68
Readme
Dockerize-CLI
Dockerize-CLI is a versatile command-line tool designed to simplify the setup of Dockerized applications for frontend, backend, or full-stack development. It automates the generation of Dockerfiles
, docker-compose.yml
, and environment configurations, saving developers time and effort while ensuring a smooth and reproducible development workflow.
Installation
You can install Dockerize-CLI globally using either npm
or pnpm
:
Using npm
npm install -g @zodiac3k/dockerize-cli
Using pnpm
pnpm install -g @zodiac3k/dockerize-cli
Usage
After installation, you can run the CLI tool using the following command:
dct
Alternatively, you can use npm
or pnpm
to invoke it:
npm dct
or
pnpm dct
Features
Dockerize-CLI provides options to quickly scaffold your project and choose the relevant technologies. Here's an overview of the available options:
- Frontend:
- Technology: React (supports TypeScript, CommonJS, or ES Modules)
- Backend:
- Technology: Node.js (supports TypeScript, CommonJS, or ES Modules)
- Database:
- Supported Databases: PostgreSQL, MongoDB, MySQL, Redis
- Database GUIs:
- PgAdmin4 (RDBMS)
- Adminer (RDBMS)
- DBeaver (RDBMS)
- RedisInsight (NoSQL)
- No GUI
- Full Stack: Work in progress
Example Workflow
- Run
dct
to start the interactive prompt. - Choose whether you want to set up a frontend, backend, database, or full stack project.
- Give your project a name and select the desired technologies.
- The tool will set up the project and ask if you'd like to Dockerize it.
- If you are creating a JavaScript/Node.js application, you can also opt for TypeScript support.
This makes it easy to get started with a Dockerized environment for quick and efficient development.
Full Stack Support
Full-stack support is currently a work in progress. Stay tuned for updates.
Why Dockerize-CLI?
Dockerize-CLI is a quick and easy way to scaffold projects that are fully Dockerized. It sets up a working development environment with Docker support, which streamlines the process of spinning up containers and sharing your environment with teammates.
Contributing
If you have suggestions or feature requests, feel free to let me know! This project is open-source, and contributions are always welcome. If you'd like to contribute, you can find the GitHub repository here:
License
This project is licensed under ISC.
Feel free to reach out with any feedback or ideas, and thank you for using Dockerize-CLI!