https://github.com/xwp/undercurrent
Common tools to facilitate frontend development and testing.
https://github.com/xwp/undercurrent
build-system gulp webpack workflow
Last synced: about 1 year ago
JSON representation
Common tools to facilitate frontend development and testing.
- Host: GitHub
- URL: https://github.com/xwp/undercurrent
- Owner: xwp
- License: mit
- Created: 2017-11-01T16:20:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T03:16:32.000Z (almost 3 years ago)
- Last Synced: 2025-04-12T15:08:02.289Z (about 1 year ago)
- Topics: build-system, gulp, webpack, workflow
- Language: JavaScript
- Homepage:
- Size: 604 KB
- Stars: 9
- Watchers: 41
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/xwp/undercurrent)
# Undercurrent
A slightly opinionated, but highly configurable build system using Gulp and Webpack for optimized frontend tooling, development and testing.
## Installation
```
yarn add -D undercurrent
```
```
npm install undercurrent --save-dev
```
## Usage
Undercurrent comes with a default schema and tasks:
- `clean`: clears the `dist` directory in the project cwd directory.
- `copy`: copies any font from `assets/fonts`;
- `images`: minifies images.
- `css`: builds CSS from SCSS using PostCSS for transformations and also provides linting using Stylelint.
- `js`: build JS using Webpack and runs ESLint and a Babel loader.
- `watch`: watches changes for `copy`, `css` and `images`.
Within the `package.json` of your project, you simply need to add a `script` to run Undercurrent:
```
cross-env NODE_ENV=development gulp --gulpfile $(npm root)/undercurrent/src/index.js --cwd $(npm prefix)
```
This script would use the default schema and workflow; however, you can write your own workflow, schema and tasks.