https://github.com/stacker/stacker-core

Stacker Engine & Templates
https://github.com/stacker/stacker-core

Last synced: about 1 year ago
JSON representation

Stacker Engine & Templates

• Host: GitHub
• URL: https://github.com/stacker/stacker-core
• Owner: stacker
• License: mit
• Created: 2017-03-07T15:00:35.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-27T09:39:22.000Z (about 9 years ago)
• Last Synced: 2025-04-01T03:36:36.469Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 65.4 KB
• Stars: 8
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Stacker Core

[![Twitter Follow](https://img.shields.io/twitter/follow/StackerHQ.svg?style=social?maxAge=2592000)](https://twitter.com/StackerHQ)

[![Version](https://img.shields.io/npm/v/stacker-core.svg)](https://www.npmjs.com/package/stacker-core)

[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/stacker/stacker-core/blob/master/LICENCE)

[![dependencies](https://david-dm.org/stacker/stacker-core.svg)](https://david-dm.org/stacker/stacker-core)

[![devDependency Status](https://david-dm.org/stacker/stacker-core/dev-status.svg)](https://david-dm.org/stacker/stacker-core#info=devDependencies)

## Usage

There are a few predefined NPM scripts available. Run them by typing this in your terminal: `npm run [script]`

| Name        | Description                                           |

| ----------  | ----------------------------------------------------- |

| `build`     | Compiles all ES2015 files to ES5 (legacy code)        |

| `build:dev` | Re-compiles the code whenever a change occurs         |

| `test`      | Runs the tests with Mocha                             |

| `test:dev`  | Re-runs the tests whenever a change occurs            |

| `lint`      | Runs `ESlint` on all files from `./src` and `./tests` |

| `lint:fix`  | Runs `ESlint` and fixes all the inconsistencies       |

| `clean`     | Removes the compiled files                            |

**NOTE:** There is another script `prepublish` that runs before you publish the package to NPM. All it does is to run `clean` and `build`.

## Templates

- [Laravel Template](src/templates/laravel/README.md)

- [Wordpress Template](src/templates/laravel/README.md)