https://github.com/nvedant/create-chakra

🌈 cli tool to scaffold chakra ui projects, without wasting time
https://github.com/nvedant/create-chakra

chakra chakra-ui chakra-ui-react chakraui nextjs reactjs typescript vue

Last synced: about 16 hours ago
JSON representation

🌈 cli tool to scaffold chakra ui projects, without wasting time

• Host: GitHub
• URL: https://github.com/nvedant/create-chakra
• Owner: nvedant
• Created: 2022-08-08T09:22:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-17T20:13:11.000Z (about 1 year ago)
• Last Synced: 2024-08-20T13:53:32.751Z (4 months ago)
• Topics: chakra, chakra-ui, chakra-ui-react, chakraui, nextjs, reactjs, typescript, vue
• Language: TypeScript
• Homepage:
• Size: 21.2 MB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - nvedant/create-chakra - 🌈 cli tool to scaffold chakra ui projects, without wasting time (TypeScript)

README

        
![create-chakra example](https://user-images.githubusercontent.com/70624701/184507059-bbed2dad-513e-4d27-b5bf-3bd43e027331.png)

## Create Chakra Project (create-chakra)

⚒ Tool to scaffold chakra apps, without wasting time. It uses existing tools like `create-next-app` and `create-vite` and then configures chakra ui in the project.

## Usage

### npx

```

npx create-chakra@latest

# OR

npx create-chakra@latest  --template 

```

### yarn

```

yarn create chakra

# OR

yarn create chakra  --template  

```

### pnpm

```

pnpm create chakra

# OR

pnpm create chakra  --template 

```

### Scaffolding tools

|id        | Template   | Tool            |

|:---------|:-----------|:----------------|

|nextjs    | Next.js    | create-next-app |

|react     | React      | create-vite     |

|vue       | Vue        | create-vite     |

NOTE: Add the `-ts` postfix to the ID to install with TypeScript

### Include template id to skip input steps

```bash

npx create-chakra@latest --template 

# OR

yarn create chakra --template 

```

## Contributing

Pull requests are always welcome, but please ensure that you've properly tested and the project is working correctly.

### Testing locally

Just clone the repo and run:

```bash

pnpm build && ./dist/index.js

# OR

pnpm build && npm i --location=global .

```

**Please, prefer using `pnpm` rather than `npm` or `yarn` while building `create-chakra` locally as it will avoid conflicts. I have not tested `create-chakra` with `npm` or `yarn`.**