# outfit-scripts

> A set of scripts used by Outfit templates.

Latest version **0.4.0** (published 2022-02-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install outfit-scripts
pnpm add outfit-scripts
yarn add outfit-scripts
bun add outfit-scripts
```

Provides the command `outfit-scripts`.

## 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.4.0 |
| Published | 2022-02-24 |
| First published | 2021-12-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | outfit-npm |

## Links

- npm: https://www.npmjs.com/package/outfit-scripts
- npm.io page: https://npm.io/package/outfit-scripts

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [dotenv](https://npm.io/package/dotenv.md) ^10.0.0
- [request](https://npm.io/package/request.md) ^2.88.2
- [archiver](https://npm.io/package/archiver.md) ^5.3.0

## Recent versions

- 0.4.0 (latest) — 2022-02-24
- 0.3.0 — 2022-01-16
- 0.2.0 — 2022-01-11
- 0.1.0 — 2021-12-22

## README

# outfit-scripts

A set of scripts used by Outfit templates.

## Usage

Add two npm scripts to zip and deploy your build.

```
  "scripts": {
        "deploy": "outfit-scripts deploy",
        "zip": "outfit-scripts zip"
    }
```

### Zip

The zip script take files from `.outfit/config.json`. Structure your `config.json` with a files array of objects, like the following:
  
  
```
{
    "files" : [
        {
            "src": "dist/",
            "directory": true
        },
        {
            "src": "public/importmap.json",
            "dist": "importmap.json"
        },
        {
            "src": "public/index.html",
            "dist": "index.html"
        },
        {
            "src": "public/templates.js",
            "dist": "templates.js"
        },
        {
            "src": "README.md",
            "dist": "README.md"
        }
    ]
}
```

### Deploy

The deploy script takes a `.outfit/.env` file into account for the required secrets


```
API_BASE_URL=
APP_ID=
USER_EMAIL=
USER_TOKEN=
TEMPLATE_NAME=
TEMPLATE_ID=
```

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