# runafe-threejs

> npm template for vue3s

Latest version **1.0.7** (published 2022-08-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install runafe-threejs
pnpm add runafe-threejs
yarn add runafe-threejs
bun add runafe-threejs
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2022-08-24 |
| First published | 2022-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 40.5 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | yes |
| Author | aile1997ccc |
| Maintainers | aile1997ccc |
| Keywords | vue3 |

## Links

- npm: https://www.npmjs.com/package/runafe-threejs
- Repository: https://github.com/aile1997/runa-threejs
- Homepage: https://github.com/aile1997/runa-threejs#readme
- Issues: https://github.com/aile1997/runa-threejs/issues
- npm.io page: https://npm.io/package/runafe-threejs

## Dependencies (8)

- [mitt](https://npm.io/package/mitt.md) ^3.0.0
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [three](https://npm.io/package/three.md) ^0.141.0
- [tween](https://npm.io/package/tween.md) ^0.9.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@types/three](https://npm.io/package/@types/three.md) ^0.141.0
- [runafe-threejs](https://npm.io/package/runafe-threejs.md) ^1.0.6
- [vite-plugin-string](https://npm.io/package/vite-plugin-string.md) ^1.1.2

## Recent versions

- 1.0.7 (latest) — 2022-08-24
- 1.0.6 — 2022-08-24
- 1.0.4 — 2022-08-23
- 1.0.2 — 2022-08-23
- 1.0.1 — 2022-08-23

## README

# README

##  Features

> It is recommended to use jsx to develop components, If you want to develop with .vue
>
> do change with pacckage.json:

```diff
"scripts": {
-  "prepublishOnly": "npm run build",
+  "prepublishOnly": "npm run build:vite",
},
```

- 💻 Vue suport >=3.2.0
- ✈️ Project init with [vite](https://vitejs.dev/)
- 📦 Support cjs & esm


- 🛎 you can write componet with .vue or .tsx

---

- 🪖 [Github Actions](https://docs.github.com/cn/actions) support (Auto CI on pull_request / Auto Release on push tag / Auto Deploy on push & pull_request)
- 🍕 Build npm package with [tsup](https://tsup.egoist.sh/)
- 🍭 Built-in Vue3 dev environment

  > [playground](./playground/vite.config.ts) folder
  >
  > start --> ```npm run dev```

- 🍔 Use [browserslistrc](./.browserslistrc)
- 🪗 Build styles with [postcss](./postcss.config.js) ([postcss-nested](https://www.npmjs.com/package/postcss-nested)/ [autoprefixer](https://www.npmjs.com/package/autoprefixer) / [cssnano](https://cssnano.co/docs/getting-started/))
- 🌭 [Stylelint](https://stylelint.io/) that helps you avoid errors and enforce conventions in your styles.
- 🍟 [Mono repo with npm](https://dev.to/ynwd/how-to-create-react-monorepo-with-npm-workspace-webpack-and-create-react-app-2dhn)
- 🎉 [TypeScript](https://www.typescriptlang.org/), of course
- 🎄 Unit Testing with [Vitest](https://vitest.dev/)
- 🏑 [Storybook](https://storybook.js.org/) for building UI components and pages
- 🧆 [ESLint](https://eslint.org/) statically analyzes your code to quickly find problems.
- ⚒ [Husky](https://typicode.github.io/husky/#/) & [lint-staged](https://github.com/okonet/lint-staged#readme)
- ☕ [Commitlint](https://commitlint.js.org) that helps your team adhering to a commit convention
- 🛸 Deploy Storybook on [Netlify](https://www.netlify.com/) ---> [config](./.github/workflows/deploy.yaml)
- 🥳 [MIT License](https://mit-license.org/)

## how to use

replace ```runafe-threejs``` with your package name

## Directory structure

```js
Project
├── __tests__           # Unit Testing
├── babel.config.js     # babel config
├── package.json
├── playground          # dev environment folder (can use source code)
│   ├── index.html
│   ├── package.json
│   ├── public
│   ├── src
│   ├── tsconfig.json
│   ├── vite-env.d.ts
│   └── vite.config.ts
├── postcss.config.js  # build styles with postcss
├── global.d.ts # global componet type declaration (TIPS: Manual maintenance is required)
├── src                # Package source code
│   ├── index.ts       # Package source entry
│   ├── stories        # storybook for building UI components and pages
│   ├── styles         # styles for Package
│   └── types.ts       # ts type declaration for Package
├── tsconfig.json      # ts config
└── tsup.config.ts     # build package with tsup
```

## Register Components Globally

```js
// main.ts
import InstallPlugin from 'runafe-threejs';

app.use(InstallPlugin());
```

```js
// tsconfig.json
{
  "compilerOptions": {
    "types": [
      "runafe-threejs/global"
    ]
  }
}
```

# runa-threejs

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