# create-rediagram-project

> Starter kit for rediagram.

Latest version **0.2.2** (published 2021-08-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-rediagram-project
pnpm add create-rediagram-project
yarn add create-rediagram-project
bun add create-rediagram-project
```

Provides the command `create-rediagram-project`.

## 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.2.2 |
| Published | 2021-08-24 |
| First published | 2020-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 171 |
| Author | kamiazya |
| Maintainers | kamiazya |

## Links

- npm: https://www.npmjs.com/package/create-rediagram-project
- Repository: https://github.com/kamiazya/rediagram
- Issues: https://github.com/kamiazya/rediagram/issues
- Funding: https://github.com/sponsors/kamiazya
- npm.io page: https://npm.io/package/create-rediagram-project

## Dependencies (9)

- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [which](https://npm.io/package/which.md) ^2.0.2
- [dedent](https://npm.io/package/dedent.md) ^0.7.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [commander](https://npm.io/package/commander.md) ^6.1.0
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.3
- [replacestream](https://npm.io/package/replacestream.md) ^4.0.3
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^3.0.0

## Recent versions

- 0.2.2 (latest) — 2021-08-24
- 0.2.1 — 2021-01-10
- 0.2.0 — 2020-12-07
- 0.1.5 — 2020-11-05
- 0.1.4 — 2020-11-05
- 0.1.3 — 2020-10-21
- 0.1.2 — 2020-10-21
- 0.1.1 — 2020-10-17
- 0.1.0 — 2020-10-17

## README

[![npm version](https://badge.fury.io/js/create-rediagram-project.svg)](https://badge.fury.io/js/create-rediagram-project)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

# create-rediagram-project

Starter kit for rediagram.

## How to use

Execute the following command to initialize the rediagram project in the specified directory.

```bash
# yarn create rediagram-project <your-project-name>
$ yarn create rediagram-project my-rediagram
🌈 Creating new rediagram project in my-rediagram.

⭐️ Installing packages. This take a couple of minutes.

yarn install v1.22.4
info No lockfile found.
[1/4] 🔍  Resolving packages...
[2/4] 🚚  Fetching packages...
[3/4] 🔗  Linking dependencies...
[4/4] 🔨  Building fresh packages...
success Saved lockfile.
✨  Done in 9.38s.

✨ The installation is complete.

👉 Get started with following commands:

    # Move to the project directory with the following command.
    $ cd my-rediagram

🚀 In the project directory, you can run:

    # Runs src/*.rediagram.tsx scripts and output the image with rediagram.
    $ yarn start

```

## Help

```bash
$ create-rediagram-project -h
Usage: create-rediagram-project [options] <name>

Options:
  -V, --version               output the version number
  -p, --package-manager <pm>  select a package manager, yarn or npm. (default: "yarn")
  -h, --help                  display help for command
```

## License

This software is released under the MIT License, see LICENSE.

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