# create-with

> `npm init with ` base code

Latest version **0.8.10** (published 2019-04-12) · 0 weekly downloads

## Install

```sh
npm install create-with
pnpm add create-with
yarn add create-with
bun add create-with
```

Provides the command `create-witn`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.10 |
| Published | 2019-04-12 |
| First published | 2018-06-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7 |
| Dependencies | 4 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | allenkim |

## Links

- npm: https://www.npmjs.com/package/create-with
- Repository: https://github.com/allenhwkim/create-with
- Homepage: https://github.com/allenhwkim/create-with#readme
- Issues: https://github.com/allenhwkim/create-with/issues
- npm.io page: https://npm.io/package/create-with

## Dependencies (4)

- [fs-extra](https://npm.io/package/fs-extra.md) ^6.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^6.0.0
- [mustache](https://npm.io/package/mustache.md) ^2.3.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.1.2

## Recent versions

- 0.8.10 (latest) — 2019-04-12
- 0.8.9 — 2019-04-12
- 0.8.8 — 2019-04-12
- 0.8.5 — 2019-04-12
- 0.8.4 — 2019-04-12
- 0.8.3 — 2019-04-12
- 0.8.2 — 2019-02-09
- 0.8.1 — 2018-06-22
- 0.8.0 — 2018-06-22
- 0.7.0 — 2018-06-22
- 0.6.0 — 2018-06-20
- 0.5.0 — 2018-06-20
- 0.4.1 — 2018-06-20
- 0.4.0 — 2018-06-20

## README

# create-with
Base code for `npm-init with`

* This repo. is the base code of `npm init with` or `npx create-with`.

## Usage
1. You can create your own npm-init template with two files with;

* `template` directory
* npm-init.json

2. Then, push to your github repository.
`$ git push`

3. Then, you are ready.
`$ npm init with myusername/my-template`

If you want it without your user name, e.g., `npm init with my-template`, 
it has to be under https://github.com/npm-init. 
Thus, pleae create an [issue](https://github.com/npm-init/create-with/issues) for it.

## Examples of `npm-init.json`
```
{
  "prompts": {
    "name": {
      "type": "string",
      "required": true,
      "message": "Project Name"
    },
    "description": {
      "type": "input",
      "required": true,
      "message": "Project Description"
    }
  },
  "completeMessage": "To get started:\n  cd {{name}}\n  npm install\n  npm start"
}
```

## Examples of `template` directory

`template` directory can have any file including any directory.
If your file contents to be dynamic, please build it as a mustache template

e.g. package.json
```
{
  "name": "{{name}}",
  "description": "{{description}}",
  "version": "0.0.0",
  "main": "dist/{{name}}.umd.js
}

## For Developers

```
$ node index.js allenhwkim/custom-element
```

MIT Licensed

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