# backpack-js > backpack-js Latest version **0.0.6** (published 2015-01-09) · 0 weekly downloads ## Install ```sh npm install backpack-js pnpm add backpack-js yarn add backpack-js bun add backpack-js ``` ## 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.6 | | Published | 2015-01-09 | | First published | 2015-01-09 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.6 | | Dependencies | 5 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | SW4 | | Maintainers | sw4 | | Keywords | node, compile, custom, build, module | ## Links - npm: https://www.npmjs.com/package/backpack-js - Repository: https://github.com/sw4/backpack - Issues: https://github.com/sw4/backpack/issues - npm.io page: https://npm.io/package/backpack-js ## Dependencies (5) - [chalk](https://npm.io/package/chalk.md) ^0.5.1 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0 - [rimraf](https://npm.io/package/rimraf.md) ^2.2.8 - [promise](https://npm.io/package/promise.md) ^6.0.1 - [archiver](https://npm.io/package/archiver.md) ^0.13.1 ## Alternatives - [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads - [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads - [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads - [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads - [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads ## Recent versions - 0.0.6 (latest) — 2015-01-09 - 0.0.5 — 2015-01-09 - 0.0.4 — 2015-01-09 - 0.0.3 — 2015-01-09 - 0.0.2 — 2015-01-09 - 0.0.1 — 2015-01-09 ## README backpack ====== [![Build Status](https://img.shields.io/travis/sw4/backpack-js.svg?style=flat-square)](https://travis-ci.org/sw4/backpack-js) [![Dependency Status](https://img.shields.io/david/sw4/backpack-js.svg?style=flat-square)](https://david-dm.org/sw4/backpack-js) [![devDependency Status](https://img.shields.io/david/dev/sw4/backpack-js.svg?style=flat-square)](https://david-dm.org/sw4/backpack-js#info=devDependencies) [![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](https://github.com/sw4/backpack-js/blob/master/LICENSE-MIT.md) [![Issues](https://img.shields.io/github/issues/sw4/backpack-js.svg?style=flat-square)](https://github.com/sw4/backpack-js/issues) [![Release](https://img.shields.io/github/release/sw4/backpack-js.svg?style=flat-square)](https://github.com/sw4/backpack-js/releases) [![Status](https://badge.fury.io/gh/sw4%2Fbackpack.png)](https://github.com/sw4/backpack-js) [![NPM](https://badge.fury.io/js/backpack.png)](https://www.npmjs.org/package/backpack) backpack.js (backpack-js, Backpack, backpack) is a Node.js module to allow users to create custom builds of your project from your website. Backpack is designed to run on a Node.js server deployment, and listens for a custom build selection to be requested, assembles it, and pushes it back to the client in `.ZIP` form. `$ npm install backpack-js --save-dev` Why backpack? --- If you have a highly modular or module orientated project, it may be the case that users may only require a subset of modules. As such, it is more efficient to offer them a build only comprising of what they need, instead of a complete code dump. Backpack automates the process of users selecting the modules they want and getting a customised build. This means users can simply browse to your site, check some boxes and voila! Have a zip file containing exactly what they need. Backpack allows: - Seamless client integration - Multiple instances of the same script to be referenced between modules, and only included once in the final build - Multiple scripts across multiple modules to be automatically bundled together into the same file - Easy definition of unique project structures for different modules How to use --- Backpack Configuration (backpack.json) ----- You will need to create a `backpack.json` file in your project directory. This file contains all settings related to your project's modules, and how to conduct a customised build. An example can be found in `examples\backpack.json`, the structure is e.g.: ``` { "url": "/backpack", "method":"POST", "modules": [ { "name": "module1", "src": [ { "src": "location/of/a/script.js", "dest": "javascript.js" } ] } ] } ``` ####`url` ######(string) optional, defaults to `/backpack` This is the URL backpack will listen to in order to trigger a custom build. ####`method` ######(string) optional, defaults to `POST` Either POST or GET. In conjunction with the URL, backpack will also check if the correct request method is being used (in case you want to use GET to serve the custom build page, and POST with the same URL to trigger it). ####`modules` ######(array) required Array of module definitions, here you set your module mappings, related assets and bundling. ####`modules/name` ######(string) required Name of the module, this is mapped to incoming requests to determine which modules are included in a build. ####`modules/src` ######(array) required List of files which constitute the module ####`modules/src/src` ######(string) Path to file ####`modules/src/dest` ######(string) optional, defaults to src value Path/name to give the output file within the custom build. It is important to note that you can give multiple `src` entries accross different modules the same `dest` entry. Where two or more files are given the same `dest`, they are bundled together into a single file. Server Configuration ----- Assuming you have a node based server already set up, you will need to require backpack, then simply add `backpack(request, response)` within you `http.createServer` function, where `request` and `response` are the respective objects passed through that function. An example of this can be found in `examples\server.js` This will ensure backpack is listening to requests made from the client, and will pick up and respond to only those relating to a custom build request. Client Configuration ----- To launch a new custom build, you will need to create a request which matches the `url` and `method` in your `backpack.json`. At the simplest level, this would constitute an HTML form which POSTs data to `/backpack` Backpack looks for the variable `backpack` in the request, representing an array of modules mapped to entries in `backpack.json`. An example form may look like (also see `example/index.html`): ```(html)

Available Modules

``` Here, `module1`, `module2` etc relate to module name values in `backpack.json`. Backpack finds the correct module entry, then creates a build based on the `src` definitions of that module. --------------------------------------------- [backpack](https://github.com/sw4/backpack-js), written by [SW4](https://github.com/sw4) --- _Source: https://npm.io/package/backpack-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._