# peque.ts

> Peque.ts Framework

Latest version **1.0.19** (published 2022-01-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install peque.ts
pnpm add peque.ts
yarn add peque.ts
bun add peque.ts
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.19 |
| Published | 2022-01-02 |
| First published | 2021-12-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 398.2 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Simone Di Cicco |
| Maintainers | devinquenti |

## Links

- npm: https://www.npmjs.com/package/peque.ts
- npm.io page: https://npm.io/package/peque.ts

## Dependencies (15)

- [os](https://npm.io/package/os.md) ^0.1.2
- [rxjs](https://npm.io/package/rxjs.md) ^7.4.0
- [axios](https://npm.io/package/axios.md) ^0.24.0
- [yamljs](https://npm.io/package/yamljs.md) ^0.3.0
- [cluster](https://npm.io/package/cluster.md) ^0.7.7
- [express](https://npm.io/package/express.md) ^4.17.1
- [mustache](https://npm.io/package/mustache.md) ^4.2.0
- [node-cron](https://npm.io/package/node-cron.md) ^3.0.0
- [socket.io](https://npm.io/package/socket.io.md) ^4.4.0
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.6
- [express-session](https://npm.io/package/express-session.md) ^1.17.2
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^4.4.0
- [swagger-ui-express](https://npm.io/package/swagger-ui-express.md) ^4.3.0
- [@apidevtools/json-schema-ref-parser](https://npm.io/package/@apidevtools/json-schema-ref-parser.md) ^9.0.9

## Recent versions

- 1.0.19 (latest) — 2022-01-02
- 1.0.18 — 2022-01-02
- 1.0.17 — 2022-01-02
- 1.0.16 — 2022-01-02
- 1.0.15 — 2021-12-30
- 1.0.14 — 2021-12-27
- 1.0.13 — 2021-12-27
- 1.0.12 — 2021-12-17
- 1.0.11 — 2021-12-16
- 1.0.10 — 2021-12-14
- 1.0.9 — 2021-12-14
- 1.0.8 — 2021-12-12
- 1.0.7 — 2021-12-11
- 1.0.6 — 2021-12-11
- 1.0.5 — 2021-12-08
- … 5 more at https://npm.io/package/peque.ts/versions

## README

# Peque.ts

![coverage](https://raw.githubusercontent.com/ukaoskid/peque-fwork/main/.badge-coverage.svg)

<center>
    <img src="https://raw.githubusercontent.com/ukaoskid/peque-fwork/main/docs/images/logo_blue.png" width="150" />
</center>

This framework is built on-top of **Express** and is intended to provide a **standard** to help the **design**, **development**,
and **life-cycle management** of **scalable** and **efficient** server-side web application (with **Node.js**).
It can also be used to **invert the control** in a pre-existent Express application.

## Install
`npm i peque.ts`

### Node version
The usage of the Node.js LTS version is required.

## Documentation
[Documentation](https://www.peque.tech)

## Server
```typescript
import { TestRootModule } from './modules/root/test-root.module';
import { ExpressFactory } from 'peque.ts';

import * as bodyParser from 'body-parser';
import * as cors from 'cors';

async function startUp() {
  await ExpressFactory.createServer({
      rootModule: TestRootModule,
      globalMiddlewares: {
        preRoutes: [
          bodyParser.urlencoded({ extended: true }),
          bodyParser.json({ limit: '2m' })
        ],
        postRoutes: [cors]
      },
      swagger: {
        folder: '/doc',
        info: {
          title: 'Test API',
          description: 'Test API description',
          contacts: {
            name: 'Simone Di Cicco',
            email: 'simone.dicicco@gmail.com'
          },
          version: '1.0.0'
        },
        servers: [{ url: 'https://api.test.com/'}],
        tags: [
          {
            name: 'Tag',
            description: 'Description'
          }
        ]
      },
      isCpuClustered: false
    }
  );
}

startUp();
```

## Examples
[https://github.com/ukaoskid/peque-fwork/tree/main/sample](https://github.com/ukaoskid/peque-fwork/tree/main/sample)

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