# DiceBear editor (beta)

[![Preview](https://raw.githubusercontent.com/dicebear/dicebear/10.x/apps/editor/preview.png)](https://editor.dicebear.com)

Read more about the project here:
[https://github.com/dicebear/dicebear/discussions/286](https://github.com/dicebear/dicebear/discussions/286)

## Recommended IDE setup

[VSCode](https://code.visualstudio.com/) +
[Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and
disable Vetur) +
[TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## Type support for `.vue` imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we
replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need
[TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)
to make the TypeScript language service aware of `.vue` types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has
also implemented a
[Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669)
that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
   2. Find `TypeScript and JavaScript Language Features`, right click and select
      `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the
   command palette.

## Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).

## Project setup

```sh
npm install
```

### Compile and hot-reload for development

```sh
npm run build
npm run dev --workspace @dicebear/editor
```

### Type-check, compile and minify for production

```sh
npm run build
```

### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint --workspace @dicebear/editor
```