# @wox/wox

> Wox application framework

Latest version **2.1.41** (published 2019-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wox/wox
pnpm add @wox/wox
yarn add @wox/wox
bun add @wox/wox
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.41 |
| Published | 2019-05-28 |
| First published | 2018-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 69.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | cevio |
| Maintainers | evio |
| Keywords | server |

## Links

- npm: https://www.npmjs.com/package/@wox/wox
- Repository: https://github.com/woxjs/wox
- Homepage: https://github.com/woxjs/wox#readme
- Issues: https://github.com/woxjs/wox/issues
- npm.io page: https://npm.io/package/@wox/wox

## Dependencies (3)

- [url-parse](https://npm.io/package/url-parse.md) ^1.4.4
- [uppercamelcase](https://npm.io/package/uppercamelcase.md) ^3.0.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Recent versions

- 2.1.41 (latest) — 2019-05-28
- 2.1.40 — 2019-05-28
- 2.1.39 — 2019-05-28
- 2.1.38 — 2019-05-28
- 2.1.37 — 2019-05-28
- 2.1.36 — 2019-05-28
- 2.1.35 — 2019-05-27
- 2.1.34 — 2019-05-22
- 2.1.33 — 2019-05-21
- 2.1.32 — 2019-05-21
- 2.1.31 — 2019-05-16
- 2.1.30 — 2019-04-23
- 2.1.29 — 2019-04-23
- 2.1.28 — 2019-04-17
- 2.1.27 — 2019-04-16
- … 87 more at https://npm.io/package/@wox/wox/versions

## README

<p align="center"><a href="https://woxjs.github.io/" target="_blank" rel="noopener noreferrer"><img width="100" src="logo.svg" alt="Wox logo"></a></p>

<p align="center">
  <a href="https://npmcharts.com/compare/@wox/wox?minimal=true"><img src="https://img.shields.io/npm/dm/@wox/wox.svg" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/@wox/wox"><img src="https://img.shields.io/npm/v/@wox/wox.svg" alt="Version"></a>
  <a href="https://www.npmjs.com/package/@wox/wox"><img src="https://img.shields.io/npm/l/@wox/wox.svg" alt="License"></a>
  <a href="https://chat.vuejs.org/"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a>
</p>

<h2 align="center">Wox.js</h2>

A dynamic loader MVC architecture based on Vue.js development which use web virtual service and web virtual request mode.

- **Virtual Service:** The virtual service system based on middleware model can decouple services between sub-services through virtual service requests, which makes the code organization and business module architecture more standardized.
- **Based on vue.js:** Use `Vue.js` as the underlying data-driven engine to make data MVVM dynamically responsive, enjoy all the features and support brought by Vue.js ecology, and quickly build the page you want.
- **Super Plugins:** Plug-ins not only aim at `UI Components`, but also provide the ability of master-slave inheritance, so that the whole project can be completed only by configuring plug-ins to achieve the effect of business module componentization.

`Wox.js` was originally designed to solve the dynamic routing problem on mobile and PC terminals. With our continuous exploration, it can carry the `empty project + multi-plug-in` mode to solve the pain point of business componentization. We constantly need to develop and balance business, so that `wox.js` can shoulder the mission of large-scale enterprise front-end application development architecture.

### Documentation

[Getting Started](https://woxjs.github.io/)

### Quick start with CLI

First you should install the official scaffolding.

```bash
$ npm i @evio/cli -g
$ cli install @wox/cli
```

Then create a new program by command.

```bash
$ cli wox:new
```

Finally start debugging development or program compilation.

```bash
$ npm run dev
$ npm run build
```

### Example

You can see the power of `wox.js` from the following code.

```javascript  
import {
  Http,
  Controller,
  Interface
} from '@wox/wox';
import IndexPage from '../webview/index.vue';
import IndexService from '../service/index';

@Controller
export default class IndexController {
  @Http.Get
  async Home() {
    const timestamp = await this.ctx.post('/timestamp');
    return <IndexPage timestamp={timestamp} />
  }

  @Http.Post('/timestamp')
  @Interface.Service('index', IndexService)
  async TimeStamp({ Service }) {
    const body = this.ctx.req.body || {};
    return await Service.index.getTime(body.delay);
  }
}
```

### Screenshots

<p align="center"><img src="./assets/wox.png" width="300" alt="preview"></p>

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2018-present, yunjie (Evio) shen

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