# create-fw

> Light framework generator for your JS projects 🪓

Latest version **1.2.1** (published 2022-01-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `create-fw`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2022-01-08 |
| First published | 2021-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | dubisdev |
| Maintainers | dubisdev |
| Keywords | npm, create, framework generator, dev-tool |

## Links

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

## Dependencies (6)

- [ora](https://npm.io/package/ora.md) ^6.0.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [execa](https://npm.io/package/execa.md) ^5.1.1
- [prompts](https://npm.io/package/prompts.md) ^2.4.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [edit-json-file](https://npm.io/package/edit-json-file.md) ^1.6.0

## Recent versions

- 1.2.1 (latest) — 2022-01-08
- 1.2.1-beta.1 (beta) — 2021-11-04
- 1.2.0 — 2021-11-02
- 1.2.0-beta.2 — 2021-11-02
- 1.2.0-beta.1 — 2021-11-01
- 1.1.0 — 2021-10-30
- 1.1.0-beta.8 — 2021-10-30
- 1.1.0-beta.7 — 2021-10-30
- 1.1.0-beta.6 — 2021-10-24
- 1.1.0-beta.5 — 2021-10-23
- 1.1.0-beta.4 — 2021-10-23
- 0.0.1-alpha.3 — 2021-10-22
- 0.0.1-alpha.2 — 2021-10-22
- 0.0.1-alpha.1 — 2021-10-22
- 0.0.1-alpha.0 — 2021-10-17

## README

# CREATE-FW 🪓

> Light framework generator for your JS projects 🪓



## 🧰 ESModules?

> ⚠️ Create-FW **does not generate CommonJS projects** since it is a non-standard technology at the time of creation of the tool. **Therefore all the generated projects will be using ESModules**.

---

<h2 align="center"> 🪓 INSTALLATION & USAGE </h2>

**Create-fw can be used in different ways.**

### Fetch from remote

By using one of the following commands:


| Package manager 	| Command          	|
|-----------------	|------------------	|
| npm             	| `npm init fw`    	|
| npx             	| `npx create-fw`  	|
| yarn            	| `yarn create fw` 	|

### Install

It is also possible to install the package globally and run it using the `create-fw` command.

#### Install the package

| Package manager 	|           Command           	|
|:---------------:	|:---------------------------:	|
| npm             	| `npm install -g create-fw`  	|
| yarn            	| `yarn global add create-fw` 	|
#### Then run the command
```sh
create-fw
```

---

<h2 align="center"> 🦴 Available Templates </h2>


| Template   	| Description                                            	|
|------------	|--------------------------------------------------------	|
| Basic      	| Starts a project with a personaliced package.json file 	|
| TypeScript 	| Creates a project for working with TS                  	|
| Jest       	| Creates a project and configures Jest                  	|
| TS + Jest  	| Creates a TS project and configures Jest               	|
| React      	| Creates a React app (Runs `create-react-app`)          	|

    
---

<h2 align="center"> ⚙ OPTIONS </h2>

### 📁 Create in folder

You can specify a folder name were the project will be started:

```sh
yarn create fw myApp
```
Generates a folder named "myApp" and starts there the project.

  <p align="center">-----</p>


### 🧰 Package manager

By default the CLI uses the package manager used for invoking the command:

        👉 `yarn create fw` - Uses yarn

        👉 `npm init fw` / `npx create-fw` - Uses npm

#### 💡 You can use some flags to change this

- [x] **`--yarn`**: forces the CLI to use yarn as package manager

  ```bash
  npm init framework-generator --yarn # will use yarn
  ```

- [x] **`--npm`**: forces the CLI to use npm as package manager

  ```bash
  yarn create fw --npm # will use npm
  ```

  <p align="center">-----</p>

### 💨 Fast mode (default options)

The **`-y` flag** sets all commands as default. It works like the -y flag in `npm init` or `yarn init`: creates the project without asking about personalization to the user.

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