https://github.com/dubisdev/create-fw

Light framework generator for your JS projects 🪓
https://github.com/dubisdev/create-fw

create framework-generator hacktoberfest javascript npm yarn

Last synced: 3 days ago
JSON representation

Light framework generator for your JS projects 🪓

• Host: GitHub
• URL: https://github.com/dubisdev/create-fw
• Owner: dubisdev
• License: mit
• Created: 2021-10-14T19:56:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-08T15:39:49.000Z (about 3 years ago)
• Last Synced: 2024-12-24T13:23:26.816Z (about 1 month ago)
• Topics: create, framework-generator, hacktoberfest, javascript, npm, yarn
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/create-fw
• Size: 374 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md
  • License: LICENSE

Awesome Lists containing this project

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**.

---

 🪓 INSTALLATION & USAGE 


**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

```

---

 🦴 Available Templates 


| 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`)          	|

    

---

 ⚙ OPTIONS 


### 📁 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.

  
-----


### 🧰 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

  ```

  
-----


### 💨 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.