# pkframe

> Client for pkframwork | Instal, webtest, auto refresh, typescript compile

Latest version **0.8.5** (published 2017-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install pkframe
pnpm add pkframe
yarn add pkframe
bun add pkframe
```

Provides the command `pkframe`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.5 |
| Published | 2017-03-26 |
| First published | 2017-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.12.0 |
| Dependencies | 14 |
| Known vulnerabilities | 0 (+9 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Sr. Pikachu |
| Maintainers | pe77 |
| Keywords | phaser, pkframework, client |

## Links

- npm: https://www.npmjs.com/package/pkframe
- Repository: https://github.com/pe77/pkframework-cli
- Homepage: https://github.com/pe77/pkframework-cli#readme
- Issues: https://github.com/pe77/pkframework-cli/issues
- npm.io page: https://npm.io/package/pkframe

## Dependencies (14)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.4.7
- [openurl](https://npm.io/package/openurl.md) ^1.1.1
- [ts-node](https://npm.io/package/ts-node.md) ^3.0.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^2.1.2
- [progress](https://npm.io/package/progress.md) ^1.1.8
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [socket.io](https://npm.io/package/socket.io.md) 1.7.0
- [livereload](https://npm.io/package/livereload.md) ^0.6.2
- [typescript](https://npm.io/package/typescript.md) ^2.2.1
- [finalhandler](https://npm.io/package/finalhandler.md) ^1.0.1
- [serve-static](https://npm.io/package/serve-static.md) ^1.12.1
- [child_process](https://npm.io/package/child_process.md) ^1.0.2
- [follow-redirects](https://npm.io/package/follow-redirects.md) ^1.2.3

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.8.5 (latest) — 2017-03-26
- 0.8.4 — 2017-03-24
- 0.8.2 — 2017-03-24
- 0.8.1 — 2017-03-24
- 0.8.0 — 2017-03-24
- 0.7.4 — 2017-03-24
- 0.7.3 — 2017-03-23
- 0.0.1 — 2017-03-23

## README

# PK Frameword :: Client  
Client for [pkframwork](https://github.com/pe77/pkframework) | install, server, liveload, typescript whatch...

>First of all: Sorry for my shitty english...

Here are just client tool usage. To learn more about framework: [Quick Start Guide](https://github.com/pe77/pkframework/wiki)

Installation
---------------

First, install [Node.js](https://nodejs.org/en/). Then, install the latest pkframe cli command-line tools in your terminal. 

```bash
$ npm install -g pkframe
```

Usage
---------------

## init

The init command will download a startup template for your project.
Basically this client will download one of the [pkframework-examples](https://github.com/pe77/pkframework-examples) as the initial template and dependences for you.

```bash
$ pkframe init
```

![](http://i.imgur.com/zhG4N8L.png)
-----------

#### Options

These are keys in the options object you can pass

- `-p [pkg-name]` example he will use as the initial template [default=basic]

> You can see anothers 'templates' [here](https://github.com/pe77/pkframework-examples). Just follow folders name.

## go

This is where the magic happens.

```bash
$ pkframe go
```
![](http://i.imgur.com/cSLjV2R.png)
-----------

This command does many things:

- Starts a web-server to test your game
- Compile(and watch modifications) typescript code and deploy
- Start your browse with liverload. Auto update whenever the code is updated

This command expects to find an [index.html], where you will start your browser with liveload.
Typescript compiler will watch for .ts files modifications except for the [assets, node_modules, vendor] folders and will deploy them to [dist / js / app.js].

```json
{
    "compilerOptions": {
        "module": "amd",
        "target": "es5",
        "sourceMap": true,
        "outFile": "dist/js/app.js"
    },
    "exclude": [
        "assets",
        "node_modules",
        "vendor"
    ]
}
```

>This can be configured in the tsconfig.json file itself. All initial models already come with a tsconfig.json preconfiguration. You can change if you want.

## install
Here it will download / install the dependencies listed in the configuration file [**pkconfig.json**]. Things like assests pack, ts and js lib.

```bash
$ pkframe install
```
If there is no configuration file, it will create a default.

```json
{
    "install": {
        "assets": {
            "url": "https://github.com/pe77/pkframework-assets/archive/master.zip",
            "folder": "assets"
        },
        "dependencies": {
            "pkframework": {
                "url": "https://github.com/pe77/pkframework/archive/master.zip",
                "use": "build/"
            }
        }
    }
}
```
>You do not have to worry about this command unless you wanted to create a package / template.
>It is automatically used when you use **pkframe init**

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