# docker-my-app

> Command Line Interface for developers to dockerize their app using ChatGPT.

Latest version **0.0.1** (published 2023-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install docker-my-app
pnpm add docker-my-app
yarn add docker-my-app
bun add docker-my-app
```

Provides the command `docker-my-app`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-11-05 |
| First published | 2023-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 15.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Karan Jagota |
| Maintainers | karan.02031993 |
| Keywords | Docker, ChatGPT, Automate Docker, cli |

## Links

- npm: https://www.npmjs.com/package/docker-my-app
- Repository: https://github.com/karanjagota/docker-my-app
- Homepage: https://github.com/karanjagota/docker-my-app#readme
- Issues: https://github.com/karanjagota/docker-my-app/issues
- npm.io page: https://npm.io/package/docker-my-app

## Dependencies (8)

- [ora](https://npm.io/package/ora.md) ^0.3.0
- [axios](https://npm.io/package/axios.md) ^1.6.0
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^3.0.1
- [request](https://npm.io/package/request.md) ^2.88.2
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.5
- [jsonexport](https://npm.io/package/jsonexport.md) ^3.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2023-11-05

## README

# docker-my-app

> **Dockerize any software project with just a few clicks.**

> **Command Line Interface for developers to dockerize their app using ChatGPT.**


## Installation

**Run**

```shell
$ npm install -g docker-my-app
```

## How to get OpenAI API Key?

Go to OpenAI's Platform website at [OpenAI](https://platform.openai.com) and sign in with an OpenAI account. Click your profile icon at the top-right corner of the page and select "View API Keys." Click "Create New Secret Key" to generate a new API key

## Usage

- First, set the api key by typing ```docker-my-app config``` in the terminal.

- Go to the project directory and run any of the below commands.

### Commands available

```shell
docker-my-app <command>

Commands:
  docker-my-app config                  [Change configuration and defaults]

  docker-my-app docker-compose.yml      [Generate docker-compose.yml file]

  docker-my-app dockerfile              [Generate Dockerfile for your project]
  
  docker-my-app dockerignore            [Generate .dockerignore File]

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]
```

#### Command `dockerfile`
Generate Dockerfile for your project.

```shell
Usage: docker-my-app dockerfile

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app dockerfile
```


#### Command `docker-compose.yml`
Generate docker-compose.yml file for your project.

```shell
Usage: docker-my-app docker-compose.yml

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app docker-compose.yml
```

#### Command `dockerignore`
Generate .dockerignore file for your project.

```shell
Usage: docker-my-app dockerignore

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app dockerignore
```

#### Command `config`
Change configuration and defaults. (Set OpenAI API Key)

```shell
Usage: docker-my-app config

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app config
  
```

## Development

Run:

```sh
$ git clone https://github.com/karanjagota/docker-my-app.git
$ cd docker-my-app
$ npm link
```

This will setup a symbolic link to the CLI. Any changes in source files will now be reflected when running the `docker-my-app` command.


## Get in touch

Send me a message on [twitter](https://twitter.com/iamkaranjagota) to know more about me or have a conversation. Share this is project by clicking the link [share](https://github.com/karanjagota/docker-my-app) 


## License


[MIT License](https://github.com/karanjagota/docker-my-app/blob/main/LICENSE)

Copyright (c) 2023 [karan jagota](https://github.com/karanjagota)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/docker-my-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
