# spored

> Local proxy for spore

Latest version **0.4.4** (published 2015-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install spored
pnpm add spored
yarn add spored
bun add spored
```

Provides the command `spored`.

## 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.4 |
| Published | 2015-06-03 |
| First published | 2015-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.11.12 |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+12 in 5 direct dependencies) |
| Install scripts | yes |
| Author | Trey Griffith |
| Maintainers | treygriffith |

## Links

- npm: https://www.npmjs.com/package/spored
- Repository: https://github.com/spore-sh/spored
- Issues: https://github.com/spore-sh/spored/issues
- npm.io page: https://npm.io/package/spored

## Dependencies (12)

- [qs](https://npm.io/package/qs.md) ^2.4.2
- [npm](https://npm.io/package/npm.md) ^2.10.1
- [nedb](https://npm.io/package/nedb.md) ^1.1.2
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [merge](https://npm.io/package/merge.md) ^1.2.0
- [which](https://npm.io/package/which.md) ^1.1.1
- [express](https://npm.io/package/express.md) ^4.12.4
- [request](https://npm.io/package/request.md) ^2.55.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.18.3
- [mustache](https://npm.io/package/mustache.md) ^2.0.0
- [commander](https://npm.io/package/commander.md) ^2.8.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.12.4

## Recent versions

- 0.4.4 (latest) — 2015-06-03

## README

spored
------

`spored` is the Spore Daemon, a small proxy server that runs locally on your machine in tandem with the [`spore-cli`](https://github.com/spore-sh/spore-cli-node) to boost performance and allow for offline capability.


### Installation

The preferred method of installation is using the [official install script](https://spore.sh/documentation#installation).

However, you can install `spored` on it's own with the following:

```
$ npm install -g spored
```

or:

```
$ npm install -g git://git@github.com:spore-sh/spored.git
```

### Starting Spored

#### Auto

`spored` should ideally be run as a daemonized server that is started automatically. This module contains
a [postinstall script](scripts/postinstall.js) to set that up on your system. Currently only OS X is supported (via `launchd`).

If you're not using OS X, you'll need to set it up yourself. If you're using Linux, you'll likely use `systemd` for this,
or `upstart` if you're using Ubuntu. On Windows, this will probably be service.

If you figure out how to get it set up for your system, please submit a Pull Request to assist others!

#### Manual

To start `spored` manually, use the following command:

```
$ spored
```

Logs will go to `stdout`, errors will go to `stderr`. The logging will
be very minimal unless you set the environment varialbe `DEBUG` to "spored".


### Contributing

1. Fork
2. Branch
3. Write (& Test)
4. Pull Request

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