open-index/open-npm huggingface dataset:
npm package: @pixelmon-minigames/pixelpals
Description: Train, feed, love and evolve your very own mischievous little Borg.
Latest version: 0.1.4

# About
Train, feed, love and evolve your very own mischievous little [Borg](https://www.pixelmon.ai/zoology/borg).

# Links
Play the game [here](https://pals.pixelmon.ai)!
npm package: @pixelmund/create-svelte-app
Description: Bootstrap your next svelte/sapper application. Choose typescript, sass or any preprocessor. Webpack or Rollup.
Author: Pixelmund
Latest version: 1.0.9

# create-svelte-app 

[![npm](https://img.shields.io/npm/v/@pixelmund/create-svelte-app?style=flat-square)](https://www.npmjs.com/package/@pixelmund/create-svelte-app) ![NPM](https://img.shields.io/npm/l/@pixelmund/create-svelte-app?style=flat-square) ![GitHub issues](https://img.shields.io/github/issues/pixelmund/create-svelte-app?style=flat-square) ![GitHub last commit](https://img.shields.io/github/last-commit/pixelmund/create-svelte-app?style=flat-square)


### Why should i use create-svelte-app?

- Use it if you're tired by repeating the setup of your svelte/sapper app everytime.
- Typescript support for both webpack and rollup projects (svelte and sapper).
- Svelte preprocessors already setup.
- Svelte config already setup for vscode.
- Easy project bootstrap, simply answer some questions and your project is ready to go!

#### Getting started

```bash
npm i @pixelmund/create-svelte-app -g
```

#### How to

If you installed the package globally simply run

```bash

create-svelte-app [alias: csa]

or

create-svelte-app [alias: csa] path [CLI will use the folder name]
```

You can also use npx:

```bash
npx @pixelmund/create-svelte-app
```


#### The CLI will ask you questions about your project

##### For Example:

`Svelte or Sapper?`
`Rollup or Webpack?`
`Typescript?`
`Css-preprocesssor?`

...will add more later

...feel free to create an issue with your needs
npm package: @pixeloven-core/common
Description: Common abstractions that have yet to find a home
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-core/common

> Pixel Oven core common

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-core/common
```

or using yarn:

```sh
yarn add @pixeloven-core/common
```
npm package: @pixeloven-core/env
Description: Environment loader
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-core/env

> Pixel Oven env.

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-core/env
```

or using yarn:

```sh
yarn add @pixeloven-core/env
```

## Usage

> Note this package should only be used for node based applications. Using in a client setting may have unintended consequences.

This package acts as a simple wrapper for [dotenv](https://www.npmjs.com/package/dotenv) and a light weight interface for accessing our `.env` file variables. The philosophy for this project enforces only a single **environment** file aptly named `.env`. It is our opinion that having multiple `.env` definitions is an anti-pattern and should be discouraged.

The ideal setup for this particular configuration is to have a single `.env` file that's not committed to source control and instead should be manged the deployment process (or local development environment). Of course the deployment process may simply be pre-defined `.env-{template}` files in source that get _deployed_ based on environment but these details we leave to you. :heart:

Alright, enough lecturing let's get to coding! ;)

To use this package is simple. For example let use the following `.env` file as an example.

```
PORT=8080
HOST=localhost
PROTOCOL=http
PUBLIC_URL=/
BUILD_PATH=dist
LOG_LEVEL=debug
MACHINE=host
DOMAIN=pixeloven.com
```

The above ENV variables are some examples of common configurations used in our projects some of which are even defined in this package. Of course more variables can be added by simply following the below pattern.

```
VARIABLE_NAME=value
```

Now, in some cases it is required to defined environment variables at run time. For example if we wanted to bootstrap our build script to create a production build of our application.

```javascript
import { env, Environment } from "@pixeloven/env";

/**
 * Initialize env variables from file
 */
env.load();

/**
 * Setup production environment
 */
const environment: Environment = "production";
env.define("BABEL_ENV", environment);
env.define("NODE_ENV", environment);
```

Once again this packages pre-defines a few common variables and even provides type definitions but we are not limited to just what is defined by this package.

Enjoy!
npm package: @pixeloven-core/exceptions
Description: Exceptions and exception handlers
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-core/exceptions

> Pixel Oven core exceptions

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-core/exceptions
```

or using yarn:

```sh
yarn add @pixeloven-core/exceptions
```
npm package: @pixeloven-core/filesystem
Description: Filesystem abstractions
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-core/filesystem

> Pixel Oven core filesystem

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-core/filesystem
```

or using yarn:

```sh
yarn add @pixeloven-core/filesystem
```
npm package: @pixeloven-core/logger
Description: Node logger
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-core/logger

> Pixel Oven core logger

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/node-logger
```

or using yarn:

```sh
yarn add @pixeloven/node-logger
```

## Usage

> Note this package should only be used for node based applications. Using in a client setting may have unintended consequences.

The primary function of this module is to act as a CLI logger. This logger consists of three log levels.

1. `info` - used for standard information and prints normally.
2. `warn` - used for warnings and highlights text in yellow.
3. `error` - Used for errors and highlights text in red.

```javascript
import { logger } from "@pixeloven-core/logger";

logger.info("Some stuff happened");
logger.warn("But not danger seems to be approaching");
logger.error("Welp I'm out!");
```

Each of these methods will print an appropriate icon to at the beginning of each line if the console supports it.
npm package: @pixeloven-core/validation
Description: Helper functions for code generation
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-core/validation

> Pixel Oven core validation

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-core/validation
```

or using yarn:

```sh
yarn add @pixeloven-core/validation
```
npm package: @pixeloven-express/dynamic-middleware
Description: Express dynamic middleware
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-express/dynamic-middleware

> Pixel Oven Express dynamic middleware.

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-express/dynamic-middleware
```

or using yarn:

```sh
yarn add @pixeloven-express/dynamic-middleware
```
npm package: @pixeloven-express/middleware-asset-manifest
Description: Express middleware for reading an asset manifest
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-express/dynamic-middleware

> Pixel Oven Express dynamic middleware.

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-express/dynamic-middleware
```

or using yarn:

```sh
yarn add @pixeloven-express/dynamic-middleware
```
npm package: @pixeloven-react/common
Description: Encapsulates react dependencies and provides a simple abstraction for common project functionality.
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-react/common

> Pixel Oven react common

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-react/common
```

or using yarn:

```sh
yarn add @pixeloven-react/common
```
npm package: @pixeloven-react/templating
Description: Defines simple react components and functionality to support server side rendering.
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-react/templating

> Pixel Oven react templating

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-react/templating
```

or using yarn:

```sh
yarn add @pixeloven-react/templating
```
npm package: @pixeloven-react/testing
Description: Encapsulates react testing dependencies and provides a simple abstraction for common testing functionality.
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-react/testing

> Pixel Oven react testing

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-react/testing
```

or using yarn:

```sh
yarn add @pixeloven-react/testing
```
npm package: @pixeloven-storybook/addons
Description: Storybook addon library
Author: Brian Gebel
Latest version: 6.0.0-beta.28

# @pixeloven-storybook/addons

> Pixel Oven storybook addons

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-storybook/config
```

or using yarn:

```sh
yarn add @pixeloven-storybook/config
```
npm package: @pixeloven-storybook/common
Description: Storybook Common
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-storybook/config

> Pixel Oven storybook config

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-storybook/config
```

or using yarn:

```sh
yarn add @pixeloven-storybook/config
```
npm package: @pixeloven-storybook/config
Description: Storybook configuration
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-storybook/config

> Pixel Oven storybook config

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-storybook/config
```

or using yarn:

```sh
yarn add @pixeloven-storybook/config
```
npm package: @pixeloven-tooling/common
Description: Common libraries for PixelOven's workflow/tooling
Author: Brian Gebel
Latest version: 6.1.0

# @pixeloven-tooling/common

> Pixel Oven tooling common

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven-tooling/common
```

or using yarn:

```sh
yarn add --dev @pixeloven-tooling/common
```
npm package: @pixeloven-tooling/compiler
Description: TypeScript abstraction for PixelOven's workflow
Author: Brian Gebel
Latest version: 6.2.0

# @pixeloven-tooling/linter

> Pixel Oven tooling linter

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven-tooling/linter
```

or using yarn:

```sh
yarn add --dev @pixeloven-tooling/linter
```

## Usage
> Note this package was originally created to encapsulate common dependencies and scripts used during the development of PixelOven. For a full public CLI experience please see our website [pixeloven](https://www.pixeloven.com/).

This simple package wraps tslint and stylelint and a few other dependencies used throughout our workflow. We often use this package side by side with lint-staged to help improve our code quality.

Example of usage in `package.json`
```json
{
  "devDependencies": {
    "@pixeloven-tooling/linter": "6.2.0",
    "lint-staged": "10.0.7"
  },
  "scripts": {
    "lint": "yarn lint:ts && yarn lint:scss",
    "lint:ts": "pixeloven-linter ts src/**/*.{ts,tsx}",
    "lint:scss": "pixeloven-linter scss src/**/*.{scss}"
  },
  "lint-staged": {
    "src/**/*.{scss}": [
      "pixeloven-linter scss"
    ],
    "src/**/*.{ts,tsx}": [
      "pixeloven-linter ts"
    ]
  }
}
```
npm package: @pixeloven-tooling/linter
Description: Linter abstraction for PixelOven's workflow
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-tooling/linter

> Pixel Oven tooling linter

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven-tooling/linter
```

or using yarn:

```sh
yarn add --dev @pixeloven-tooling/linter
```

## Usage
> Note this package was originally created to encapsulate common dependencies and scripts used during the development of PixelOven. For a full public CLI experience please see our website [pixeloven](https://www.pixeloven.com/).

This simple package wraps tslint and stylelint and a few other dependencies used throughout our workflow. We often use this package side by side with lint-staged to help improve our code quality.

Example of usage in `package.json`
```json
{
  "devDependencies": {
    "@pixeloven-tooling/linter": "6.2.0",
    "lint-staged": "10.0.7"
  },
  "scripts": {
    "lint": "yarn lint:ts && yarn lint:scss",
    "lint:ts": "pixeloven-linter ts src/**/*.{ts,tsx}",
    "lint:scss": "pixeloven-linter scss src/**/*.{scss}"
  },
  "lint-staged": {
    "src/**/*.{scss}": [
      "pixeloven-linter scss"
    ],
    "src/**/*.{ts,tsx}": [
      "pixeloven-linter ts"
    ]
  }
}
```
npm package: @pixeloven-tooling/pretty
Description: Prettier abstraction for PixelOven's workflow
Author: Brian Gebel
Latest version: 6.2.0

# @pixeloven-tooling/pretty

> Pixel Oven tooling pretty

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven-tooling/pretty
```

or using yarn:

```sh
yarn add --dev @pixeloven-tooling/pretty
```

## Usage
> Note this package was originally created to encapsulate common dependencies and scripts used during the development of PixelOven. For a full public CLI experience please see our website [pixeloven](https://www.pixeloven.com/).

This simple package wraps prettier for use throughout our workflow. We often use this package side by side with lint-staged to help improve our code quality.

Example of usage in `package.json`
```json
{
  "devDependencies": {
    "@pixeloven-tooling/pretty": "6.2.0",
    "lint-staged": "10.0.7"
  },
  "scripts": {
    "pretty": "pixeloven-pretty src/**/*.{scss,ts,tsx}"
  },
  "lint-staged": {
    "src/**/*.{scss,ts,tsx}": [
      "pixeloven-pretty"
    ]
  }
}
```
npm package: @pixeloven-tooling/test
Description: Jest abstraction for PixelOven's workflow
Author: Brian Gebel
Latest version: 6.2.0

# @pixeloven-tooling/test

> Pixel Oven tooling test

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven-tooling/test
```

or using yarn:

```sh
yarn add --dev @pixeloven-tooling/test
```

## Usage
> Note this package was originally created to encapsulate common dependencies and scripts used during the development of PixelOven. For a full public CLI experience please see our website [pixeloven](https://www.pixeloven.com/).

This simple package wraps jest, sinon and a few other dependencies used throughout our workflow.

Example of usage in `package.json`
```json
{
  "devDependencies": {
    "@pixeloven-tooling/test": "6.2.0"
  },
  "scripts": {
    "test": "pixeloven-test --color --coverage",
    "test:ci": "pixeloven-test --ci --coverage",
    "test:watch": "pixeloven-test --watch"
  }
}
```
npm package: @pixeloven-webpack/bundler
Description: Webpack build handler
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven/webpack-bundler

> Pixel Oven webpack bundler

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack-bundler
```

or using yarn:

```sh
yarn add @pixeloven/webpack-bundler
```
npm package: @pixeloven-webpack/compiler
Description: Wrapper class for webpack compiler
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-webpack/compiler

> Pixel Oven webpack-compiler.

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/compiler
```

or using yarn:

```sh
yarn add @pixeloven-webpack/compiler
```

## Usage

> Note it's required that we provide a "client" and "server" configuration as an array to webpack.

The primary function of this module is to act as a wrapper class for webpack's compiler. Additionally it Provides functionality useful for interfacing with webpack's compiler and it's corresponding configuration and output.

1. `create` - This static method will return us a new Compiler instance based on our desired configuration.

```javascript
// webpack.config.js

export default [
    {
        name: 'client',
        target: 'web',
        entry: './client.js'
        ...
    }, {
        name: 'server',
        target: 'node',
        entry: './server.js'
        ...
    }
];
```

We can take this configuration and compile it like shown below.

```javascript
import { Compiler } from "@pixeloven-webpack/compiler";
import configs from "./webpack.config.js";

Compiler.create(configs);
```
npm package: @pixeloven-webpack/config
Description: Webpack configuration for client and server
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-webpack/config

> Pixel Oven webpack config

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/config
```

or using yarn:

```sh
yarn add @pixeloven-webpack/config
```
npm package: @pixeloven-webpack/file-reporter
Description: Webpack file reporter
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven-webpack/file-reporter

> Pixel Oven webpack file reporter

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/file-reporter
```

or using yarn:

```sh
yarn add @pixeloven-webpack/file-reporter
```
npm package: @pixeloven-webpack/server
Description: Webpack Development Server
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-webpack/server

> Pixel Oven Webpack Development Server.

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/server
```

or using yarn:

```sh
yarn add @pixeloven-webpack/server
```
npm package: @pixeloven-webpack/server-middleware
Description: Webpack Development Server middleware
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-webpack/server-middleware

> Pixel Oven Webpack Development Server middleware.

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/server-middleware
```

or using yarn:

```sh
yarn add @pixeloven-webpack/server-middleware
```

## Usage
npm package: @pixeloven-webpack/ts-loader
Description: Collection of loaders to handle TypeScript and other advanced JS features
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-webpack/ts-loader

> Pixel Oven webpack TypeScript Loader

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/ts-loader
```

or using yarn:

```sh
yarn add @pixeloven-webpack/ts-loader
```
npm package: @pixeloven-webpack/types
Description: Collection of shared types for @pixeloven-webpack
Author: Brian Gebel
Latest version: 6.1.0

# @pixeloven-webpack/types

> Pixel Oven webpack types

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven-webpack/types
```

or using yarn:

```sh
yarn add @pixeloven-webpack/types
```
npm package: @pixeloven/cli
Description: Command line interface for PixelOven framework
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven/cli

> Pixel Oven cli

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli
```
npm package: @pixeloven/cli-addon-generators
Description: PixelOven CLI Common code generators
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-core/cli-addon-generators

> Pixel Oven cli addon generators

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli-addon-generators
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli-addon-generators
```

## Generating components

See the [generator specific docs](https://www.pixeloven.com/docs/getting-started/generator).
npm package: @pixeloven/cli-addon-gh-pages
Description: Publishes project docs to GitHub Pages
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-core/cli-addon-gh-pages

> Pixel Oven generators

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli-addon-gh-pages
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli-addon-gh-pages
```
npm package: @pixeloven/cli-addon-storybook
Description: PixelOven CLI addon for storybook based development
Author: Brian Gebel
Latest version: 7.0.0-alpha.1

# @pixeloven-core/cli-addon-storybook

> Pixel Oven cli addon storybook

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli-addon-storybook
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli-addon-storybook
```
npm package: @pixeloven/cli-addon-stylelint
Description: Wrapper for Style Lint
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-core/cli-addon-stylelint

> Pixel Oven stylelint

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli-addon-stylelint
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli-addon-stylelint
```
npm package: @pixeloven/cli-addon-tslint
Description: Wrapper for TS Lint
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-core/cli-addon-tslint

> Pixel Oven tslint

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli-addon-tslint
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli-addon-tslint
```
npm package: @pixeloven/cli-addon-webpack
Description: PixelOven CLI addon for webpack based development
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven-core/cli-addon-webpack

> Pixel Oven cli addon webpack

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli-addon-webpack
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli-addon-webpack
```
npm package: @pixeloven/cli-core
Description: Core command line interface for PixelOven framework
Author: Brian Gebel
Latest version: 7.0.0-alpha.0

# @pixeloven/cli

> Pixel Oven cli

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cli
```

or using yarn:

```sh
yarn add --dev @pixeloven/cli
```
npm package: @pixeloven/commit-config
Description: Commit lint configuration
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven/commit-config

> Pixel Oven Commit lint configuration

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/commit-config
```

or using yarn:

```sh
yarn add --dev @pixeloven/commit-config
```

## Usage

Example of usage in `commitlint.config.js`

```javascript
module.exports = {
    extends: ["@pixeloven/commit-config"],
};
```
npm package: @pixeloven/core
Description: Core Framework
Author: Brian Gebel
Latest version: 6.0.0-beta.2

# @pixeloven/core

> Pixel Oven core.

See our website [pixeloven-core](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/core
```

or using yarn:

```sh
yarn add @pixeloven/core
```
npm package: @pixeloven/cz-simplified-changelog
Description: Commit citizen simplified changelog prompt
Author: Brian Gebel
Latest version: 6.4.0

# @pixeloven/cz-simplified-changelog

> Pixel Oven Commit Citizen simplified changelog

See our website [PixelOven](https://www.pixeloven.com/) for more information or our [issues](https://github.com/pixeloven/pixeloven/issues) board to report issues associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/cz-simplified-changelog
```

or using yarn:

```sh
yarn add --dev @pixeloven/cz-simplified-changelog
```

## Usage

Example of usage in `package.json`

```json
  "config": {
    "commitizen": {
      "path": "./node_modules/@pixeloven/cz-simplified-changelog"
    }
  }
```
npm package: @pixeloven/docs
Description: Documentation generators
Author: Brian Gebel
Latest version: 4.2.1

# @pixeloven/docs

> Pixel Oven docs.

See our website [pixeloven-docs](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/docs
```

or using yarn:

```sh
yarn add @pixeloven/docs
```
npm package: @pixeloven/env
Description: Environment loader
Author: Brian Gebel
Latest version: 6.0.0-beta.2

# @pixeloven/env

> Pixel Oven env.

See our website [pixeloven-env](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/env
```

or using yarn:

```sh
yarn add @pixeloven/env
```

## Usage
> Note this package should only be used for node based applications. Using in a client setting may have unintended consequences.

This package acts as a simple wrapper for [dotenv](https://www.npmjs.com/package/dotenv) and a light weight interface for accessing our `.env` file variables. The philosophy for this project enforces only a single **environment** file aptly named `.env`. It is our opinion that having multiple `.env` definitions is an anti-pattern and should be discouraged.

The ideal setup for this particular configuration is to have a single `.env` file that's not committed to source control and instead should be manged the deployment process (or local development environment). Of course the deployment process may simply be pre-defined `.env-{template}` files in source that get *deployed* based on environment but these details we leave to you. :heart:

Alright, enough lecturing let's get to coding! ;)

To use this package is simple. For example let use the following `.env` file as an example.
```
PORT=8080
HOST=localhost
PROTOCOL=http
PUBLIC_URL=/
BUILD_PATH=dist
LOG_LEVEL=debug
MACHINE=host
DOMAIN=pixeloven.com
```
The above ENV variables are some examples of common configurations used in our projects some of which are even defined in this package. Of course more variables can be added by simply following the below pattern.

```
VARIABLE_NAME=value
```

Now, in some cases it is required to defined environment variables at run time. For example if we wanted to bootstrap our build script to create a production build of our application.
```javascript
import { env, Environment } from "@pixeloven/env";

/**
 * Initialize env variables from file
 */
env.load();

/**
 * Setup production environment
 */
const environment: Environment = "production";
env.define("BABEL_ENV", environment);
env.define("NODE_ENV", environment);
```
Once again this packages pre-defines a few common variables and even provides type definitions but we are not limited to just what is defined by this package.

Enjoy!
npm package: @pixeloven/exceptions
Description: Exceptions and exception handlers
Author: Brian Gebel
Latest version: 6.0.0-beta.2

# @pixeloven/exceptions

> Pixel Oven exceptions.

See our website [pixeloven-exceptions](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/exceptions
```

or using yarn:

```sh
yarn add @pixeloven/exceptions
```
npm package: @pixeloven/express-dynamic-middleware
Description: Express dynamic middleware
Author: Brian Gebel
Latest version: 6.0.0-beta.2

# @pixeloven/express-dynamic-middleware

> Pixel Oven Express dynamic middleware.

See our website [pixeloven-express-dynamic-middleware](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/express-dynamic-middleware
```

or using yarn:

```sh
yarn add @pixeloven/express-dynamic-middleware
```

## Usage
npm package: @pixeloven/generators
Description: Common code generators
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/generators

> Pixel Oven generators

See our website [pixeloven-generators](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/generators
```

or using yarn:

```sh
yarn add @pixeloven/generators
```

## Generating components

Refer to [the component instrucions](https://github.com/pixeloven/pixeloven/blob/master/packages/pixeloven-generators/component.md)

## Generating stores

Refer to [the store instrucions](https://github.com/pixeloven/pixeloven/blob/master/packages/pixeloven-generators/store.md)
npm package: @pixeloven/node-logger
Description: Node logger
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/node-logger

> Pixel Oven node-logger.

See our website [pixeloven-node-logger](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/node-logger
```

or using yarn:

```sh
yarn add @pixeloven/node-logger
```

## Usage
> Note this package should only be used for node based applications. Using in a client setting may have unintended consequences.

The primary function of this module is to act as a CLI logger. This logger consists of three log levels.

1. `info` - used for standard information and prints normally.
3. `warn` - used for warnings and highlights text in yellow.
1. `error` - Used for errors and highlights text in red.


```javascript
import { logger } from "@pixeloven/node-logger";

logger.info("Some stuff happened");
logger.warn("But not danger seems to be approaching");
logger.error("Welp I'm out!");
```
Each of these methods will print an appropriate icon to at the beginning of each line if the console supports it.
npm package: @pixeloven/storybook
Description: Storybook configuration
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/storybook

> Pixel Oven docs.

See our website [pixeloven-docs](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/storybook
```

or using yarn:

```sh
yarn add @pixeloven/storybook
```
npm package: @pixeloven/tasks
Description: Common tasks used during development of PixelOven
Author: Brian Gebel
Latest version: 6.0.0-beta.22

# @pixeloven/tasks

> Pixel Oven tasks

See our website [pixeloven-tasks](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save-dev @pixeloven/tasks
```

or using yarn:

```sh
yarn add --dev @pixeloven/tasks
```

## Usage
> Note this package was originally created to encapsulate common dependencies and scripts used during the development of PixelOven. For a full public CLI experience please see [@pixeloven/cli](https://www.npmjs.com/package/@pixeloven/cli).

When making a libraries similar to the ones seen in [PixelOven](https://github.com/pixeloven/pixeloven) we can use this simple wrapper for common tasks like linting, compiling and testing. 

Example of usage in `package.json`
```json
  "scripts": {
    "clean": "pixeloven-tasks clean",
    "compile": "pixeloven-tasks compile:ts",
    "precompile": "pixeloven-tasks compile:clean",
    "document": "pixeloven-tasks document:ts src",
    "predocument": "pixeloven-tasks document:clean",
    "lint": "yarn lint:ts",
    "lint:ts": "pixeloven-tasks lint:ts src/**/*.{ts,tsx}",
    "pretest": "pixeloven-tasks test:clean",
    "pretty": "pixeloven-tasks pretty src/**/*.{ts,tsx}",
    "pretty:ts": "pixeloven-tasks pretty:ts src/**/*.{ts,tsx}",
    "test": "pixeloven-tasks test --color --coverage",
    "test:ci": "pixeloven-tasks test --ci --coverage",
    "test:watch": "pixeloven-tasks test:watch"
  }
```
npm package: @pixeloven/webpack
Description: Webpack wrapper for CLI integration
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/webpack

> Pixel Oven webpack

See our website [pixeloven-webpack](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack
```

or using yarn:

```sh
yarn add @pixeloven/webpack
```
npm package: @pixeloven/webpack-builder
Description: Webpack build handler
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/webpack-builder

> Pixel Oven webpack bui

See our website [pixeloven-webpack-builder](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack-builder
```

or using yarn:

```sh
yarn add @pixeloven/webpack-builder
```
npm package: @pixeloven/webpack-compiler
Description: Wrapper class for webpack compiler
Author: Brian Gebel
Latest version: 6.0.0-beta.2

# @pixeloven/webpack-compiler

> Pixel Oven webpack-compiler.

See our website [pixeloven-webpack-compiler](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack-compiler
```

or using yarn:

```sh
yarn add @pixeloven/webpack-compiler
```

## Usage
> Note it's required that we provide a "client" and "server" configuration as an array to webpack.

The primary function of this module is to act as a wrapper class for webpack's compiler. Additionally it Provides functionality useful for interfacing with webpack's compiler and it's corresponding configuration and output.

1. `create` - This static method will return us a new Compiler instance based on our desired configuration.

```javascript
// webpack.config.js
 
export default [
    {
        name: 'client',
        target: 'web',
        entry: './client.js'
        ...
    }, {
        name: 'server',
        target: 'node',
        entry: './server.js'
        ...
    }
];
```

We can take this configuration and compile it like shown below.
```javascript
import { Compiler } from "@pixeloven/webpack-compiler";
import configs from "./webpack.config.js"

Compiler.create(configs);
```
npm package: @pixeloven/webpack-config
Description: Webpack configuration for client and server
Author: Brian Gebel
Latest version: 6.0.0-beta.2

# @pixeloven/webpack-config

> Pixel Oven webpack config

See our website [pixeloven-webpack-config](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack-config
```

or using yarn:

```sh
yarn add @pixeloven/webpack-config
```
npm package: @pixeloven/webpack-dev-server
Description: Webpack Development Server
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/webpack-dev-server

> Pixel Oven Webpack Development Server.

See our website [pixeloven-webpack-dev-server](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack-dev-server
```

or using yarn:

```sh
yarn add @pixeloven/webpack-dev-server
```

## Usage
npm package: @pixeloven/webpack-dev-server-middleware
Description: Webpack Development Server middleware
Author: Brian Gebel
Latest version: 6.0.0-beta.3

# @pixeloven/webpack-dev-server-middleware

> Pixel Oven Webpack Development Server middleware.

See our website [pixeloven-webpack-dev-server-middleware](https://github.com/pixeloven/pixeloven) for more information or the [issues](https://github.com/pixeloven/pixeloven) associated with this package.

## Install

Using npm:

```sh
npm install --save @pixeloven/webpack-dev-server-middleware
```

or using yarn:

```sh
yarn add @pixeloven/webpack-dev-server-middleware
```

## Usage
npm package: @pixelpay/capacitor-plugin
Description: Native bridge with Capacitor plugin and PixelPaySDK
Author: Ivan Suazo
Latest version: 2.0.13

# Librería de desarrollo para el Framework IONIC/Capacitor

## ¿Como instalar?

Los paquetes oficiales de NPM son [@pixelpay/sdk-core](https://www.npmjs.com/package/@pixelpay/sdk-core) y [@pixelpay/capacitor-plugin](https://www.npmjs.com/package/@pixelpay/capacitor-plugin).

Utiliza los siguientes comandos para su descarga e instalación:

``` bash
npm install @pixelpay/sdk-core
npm install @pixelpay/capacitor-plugin
```

Integración Ionic/IOS

Consulta la [Documentación oficial](https://ionicframework.com/docs/developing/ios) de Ionic para más información.

Integración Ionic/Android

Consulta la [Documentación oficial](https://ionicframework.com/docs/developing/android) de Ionic para más información.
npm package: @pixelpay/fonts
Description: Iconos y Fuente principal para PixelPay
Author: Ivan Suazo
Latest version: 1.1.6

<link rel="stylesheet" type="text/css" href="https://unpkg.com/@pixelpay/fonts/dist/poppins.css" />
<style>
body {
	font-family: 'Poppins', 'Arial', sans-serif !important;
}
</style>

# Iconos y fuentes de PixelPay

## Uso y recomendaciones

En este paquete se encuentran 3 tipos de fuentes:

- Poppins (PixelPay fuente base del UI)
- Icons (Coleccion de iconos del UI)
- Logos (Marcas, sellos y logos)
- Social (Logos e iconos de redes sociales)

Para poder ser utilizados deben de incluirse las hojas de estilo en la etiqueta `<head/>` via **CDN** de la siguiente forma:

``` html
...

<!-- Base Font -->
<link rel="stylesheet" type="text/css" href="https://unpkg.com/@pixelpay/fonts/dist/poppins.css" />

<!-- Icons Font -->
<link rel="stylesheet" type="text/css" href="https://unpkg.com/@pixelpay/fonts/dist/logos.css" />

<!-- Logos Font -->
<link rel="stylesheet" type="text/css" href="https://unpkg.com/@pixelpay/fonts/dist/icons.css" />

<!-- Social Font -->
<link rel="stylesheet" type="text/css" href="https://unpkg.com/@pixelpay/fonts/dist/social.css" />

...
```

o tambien puede ser incluido en cualquier proyecto de javascript incluyendolo asi:

``` js
// Import support
import '@pixelpay/fonts/dist/poppins.css';
import '@pixelpay/fonts/dist/opensans.css';
import '@pixelpay/fonts/dist/icons.css';
import '@pixelpay/fonts/dist/logos.css';
import '@pixelpay/fonts/dist/social.css';

/* --- or --- */

// Require support
require('@pixelpay/fonts/dist/poppins.css');
require('@pixelpay/fonts/dist/opensans.css');
require('@pixelpay/fonts/dist/icons.css');
require('@pixelpay/fonts/dist/logos.css');
require('@pixelpay/fonts/dist/social.css');
```

Para poder utilizar la fuente **Poppins** debera de definir la propiedad css `font-family` en el elemento que se desee:

``` css
body {
	font-family: 'Poppins', 'Arial', sans-serif;
}
```

Para poder utilizar la fuente **icons** puede visualizar la lista de códigos [aquí](unpkg.com/@pixelpay/fonts/dist/icons.html) y agregarlo como clase en la etiqueta `<i/>` con el prefijo `icon-` de la siguiente forma:

``` html
<!-- example -->
<i class="icon-plus"></i>
```

Para poder utilizar la fuente **logos** puede visualizar la lista de códigos [aquí](unpkg.com/@pixelpay/fonts/dist/logos.html) y agregarlo como clase en la etiqueta `<i/>` con el prefijo `logo-` de la siguiente forma:

``` html
<!-- example -->
<i class="logo-pixelpay"></i>
```

Para poder utilizar la fuente **social** puede visualizar la lista de códigos [aquí](unpkg.com/@pixelpay/fonts/dist/social.html) y agregarlo como clase en la etiqueta `<i/>` con el prefijo `social-` de la siguiente forma:

``` html
<!-- example -->
<i class="social-facebook"></i>
```