# geodash-build-pipeline

> Low-level Javascript library for the [GeoDash](http://geodash.io) Gulp-based build pipeline. This API includes a variety of low-level functions that can be used throughout a `gulpfile`.

Latest version **0.0.4** (published 2017-04-11) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install geodash-build-pipeline
pnpm add geodash-build-pipeline
yarn add geodash-build-pipeline
bun add geodash-build-pipeline
```

## 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.0.4 |
| Published | 2017-04-11 |
| First published | 2016-10-23 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 20 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | GeoDash Developers |
| Maintainers | pjdufour |
| Keywords | map, mapping, gis, gulp, geodash |

## Links

- npm: https://www.npmjs.com/package/geodash-build-pipeline
- Repository: https://github.com/geodashio/geodash-build-pipeline
- Homepage: http://geodash.io/
- Issues: https://github.com/geodashio/geodash-build-pipeline/issues
- npm.io page: https://npm.io/package/geodash-build-pipeline

## Dependencies (20)

- [gulp](https://npm.io/package/gulp.md) ^3.9.0
- [path](https://npm.io/package/path.md) *
- [merge](https://npm.io/package/merge.md) *
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [yamljs](https://npm.io/package/yamljs.md) ^0.2.7
- [gulp-less](https://npm.io/package/gulp-less.md) *
- [gulp-util](https://npm.io/package/gulp-util.md) *
- [typescript](https://npm.io/package/typescript.md) ~2.1.0
- [gulp-concat](https://npm.io/package/gulp-concat.md) *
- [gulp-jshint](https://npm.io/package/gulp-jshint.md) *
- [gulp-rename](https://npm.io/package/gulp-rename.md) *
- [gulp-tslint](https://npm.io/package/gulp-tslint.md) ^3.6.0
- [gulp-uglify](https://npm.io/package/gulp-uglify.md) *
- [gulp-replace](https://npm.io/package/gulp-replace.md) *
- [gulp-s3-upload](https://npm.io/package/gulp-s3-upload.md) *
- [expand-home-dir](https://npm.io/package/expand-home-dir.md) *
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^1.6.0
- [gulp-typescript](https://npm.io/package/gulp-typescript.md) ~3.1.6
- [geodash-build-log](https://npm.io/package/geodash-build-log.md) *
- [gulp-angular-templatecache](https://npm.io/package/gulp-angular-templatecache.md) ^1.8.0

## Recent versions

- 0.0.4 (latest) — 2017-04-11
- 0.0.3 — 2017-01-25
- 0.0.2 — 2017-01-22
- 0.0.1 — 2016-10-23

## README

# GeoDash Build Pipeline (geodash-build-pipeline)

Low-level Javascript library for the [GeoDash](http://geodash.io) Gulp-based build pipeline.  This API includes a variety of low-level functions that can be used throughout a `gulpfile`.

## GeoDash

GeoDash is a modern web framework and approach for quickly producing visualizations of geospatial data. The name comes from "geospatial dashboard".

The framework is built to be extremely extensible. You can use GeoDash Server (an implementation), the front-end framework, backend code, or just the Gulp pipeline. Have fun!

See [http://geodash.io](http://geodash.io) for more details.

# Install

Install with [npm](https://npmjs.org/package/geodash-build-pipeline)

```
npm install geodash-build-pipeline --save-dev
```

# Usage

This library should be used in a `gulpfile` when building a GeoDash application.  It is not developed for the GeoDash `runtime` environment in the browser, as such the package is prefixed with `geodash-build-`.  To load into a gulpfile, add the following:

```
var geodash = require("geodash-build-pipeline");
```

You can then use functions like:

```
geodash.resolve.path(...)
geodash.log.error(...)
```

Build the docs for the full API.  For an example see the GeoDash Viewer [gulpfile.js](https://github.com/geodashio/geodash-viewer-angular/blob/master/gulpfile.js).

# Building

## Docs

To build the custom docs template used in the website, you'll need to install a custom version of docstrap.git on top of the default version.  The below command will install the custom version.

```
npm install git+https://git@github.com/geodashio/docstrap.git\#geodash # Install custom docs template with font awesome
```

You can just build docs with:
```
npm run build:docs # or gulp docs since run the same thing
```

# Tests

Only [jshint](http://jshint.com/about/) is supported right now.  Run tests with the following command.

```
npm run tests
```

# Contributing

Happy to accept pull requests!

# License

See `LICENSE` file.

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