# slush-good-start

> A slush generator for project with testing, eslint, config, testing, and webstorm project settings.

Latest version **0.1.2** (published 2016-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install slush-good-start
pnpm add slush-good-start
yarn add slush-good-start
bun add slush-good-start
```

## 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.1.2 |
| Published | 2016-10-10 |
| First published | 2016-10-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Christopher Holmok |
| Maintainers | holmok, wayblazer-eng |
| Keywords | slushgenerator, webstorm, eslint, config, logging, testing |

## Links

- npm: https://www.npmjs.com/package/slush-good-start
- Repository: https://github.com/wayblazer/slush-good-start
- Issues: https://github.com/wayblazer/slush-good-start/issues
- npm.io page: https://npm.io/package/slush-good-start

## Dependencies (6)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [inquirer](https://npm.io/package/inquirer.md) ^1.2.1
- [gulp-rename](https://npm.io/package/gulp-rename.md) ^1.2.2
- [gulp-install](https://npm.io/package/gulp-install.md) ^0.6.0
- [gulp-conflict](https://npm.io/package/gulp-conflict.md) ^0.4.0
- [gulp-template](https://npm.io/package/gulp-template.md) ^4.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2016-10-10
- 0.1.1 — 2016-10-10
- 0.1.0 — 2016-10-07

## README

# Slush-Test

> A [slush](http://slushjs.github.io) generator for a simple node app with all the good stuff

## Installation

Install `slush-good-start` globally:

```bash
npm install -g slush-good-start
```

Remember to install `slush` globally as well, if you haven't already:

```bash
npm install -g slush
```

## Usage

Create a new folder for your project:

```bash
mkdir my-new-app
```

Run the generator from within the new folder:

```bash
cd my-new-app

slush good-start
```

Answer the questions and it will generate all the stuff you need.


### Linting

It uses [eslint](http://eslint.org/) and [Airbnb's linting module](https://www.npmjs.com/package/eslint-config-airbnb)

This can be ran via: ```npm run-script lint```

### Nodemon

It uses [nodemon](http://nodemon.io/)

This can be ran via: ```npm run-script nodemon```

### Testing

It uses [mocha](https://mochajs.org/) and [chai](http://chaijs.com/) and [sinon](http://sinonjs.org/)

This can be ran via: ```npm run-script test```

### Logging

It uses [bunyan](https://github.com/trentm/node-bunyan) and [bunyan-prettystream](https://github.com/mrrama/node-bunyan-prettystream)

### Other Modules
 + lodash
 + moment
 + config
 + async
 
### Webstorm

It also include a nice configured webstorm project file
 
### Precommit hooks

Linting and testing is ran prior to commits and will not commit on failure.

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