README.md at master · sanin.dev/build-shit

sanin.dev / build-shit

Tiny script for preparing web assets for deployment

build-shit / README.md

at master 983 B view raw view rendered

 1# build-shit
 2
 3[![GitHub License](https://img.shields.io/github/license/CorySanin/build-shit)](https://tangled.sh/@sanin.dev/build-shit/blob/master/LICENSE)
 4[![NPM Version](https://img.shields.io/npm/v/forking-build-shit)](https://www.npmjs.com/package/forking-build-shit)
 5[![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/forking-build-shit)](https://www.npmjs.com/package/forking-build-shit)
 6
 7A build script for preparing files for production. It handles CSS and JavaScript minification, Sass compilation, and image conversion to WebP and AVIF.
 8
 9WebP conversion requires libwebp. AVIF conversion requires avifenc.
10
11## Installation
12
13```
14npm install --save-dev forking-build-shit
15```
16
17## Usage
18
19build-shit processes files from the following relative directories:
20
21- `styles/` - Contains SCSS files
22- `scripts/` - Contains JavaScript files
23- `assets/images/original/` - Contains image files
24
25After populating these directories, run the build script with `npx build-shit`.