# online-explorer

> An online file explorer

Latest version **1.1.1** (published 2017-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install online-explorer
pnpm add online-explorer
yarn add online-explorer
bun add online-explorer
```

Provides the command `online-explorer`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2017-02-14 |
| First published | 2017-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | helloqiu |
| Maintainers | helloqiu |
| Keywords | file, explorer, online |

## Links

- npm: https://www.npmjs.com/package/online-explorer
- Repository: https://github.com/helloqiu/online-explorer
- Homepage: https://github.com/helloqiu/online-explorer#readme
- Issues: https://github.com/helloqiu/online-explorer/issues
- npm.io page: https://npm.io/package/online-explorer

## Dependencies (5)

- [express](https://npm.io/package/express.md) ^4.14.1
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [directory-tree](https://npm.io/package/directory-tree.md) ^1.2.0
- [content-disposition](https://npm.io/package/content-disposition.md) ^0.5.2
- [connect-history-api-fallback](https://npm.io/package/connect-history-api-fallback.md) ^1.3.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.1.1 (latest) — 2017-02-14
- 1.0.9 — 2017-02-14
- 1.0.8 — 2017-02-10
- 1.0.6 — 2017-02-10
- 1.0.5 — 2017-02-04
- 1.0.4 — 2017-02-04
- 1.0.3 — 2017-02-03
- 1.0.2 — 2017-02-03
- 1.0.1 — 2017-02-03
- 1.0.0 — 2017-02-03

## README

# Online Explorer  
[![Docker Repository on Quay](https://quay.io/repository/helloqiu/online-explorer/status "Docker Repository on Quay")](https://quay.io/repository/helloqiu/online-explorer)  
An online file explorer.
# Install
Use npm:
```
npm i online-explorer
```
**Note: Please do not use the git version directly. Remember to build first.**  

# Usage

## command line  
```
Usage: online-explorer [options]

  Options:

    -h, --help        output usage information
    -V, --version     output the version number
    --host <host>     host on which to listen to (default 127.0.0.1)
    -p --port <port>  port on which to listen to (default 3000)
```
Or try docker:
```
docker pull quay.io/helloqiu/online-explorer
docker run -d \
  --name online-explorer \
  --restart always \
  -p 3000:3000 \
  -v path-you-want-to-explore:/web-files quay.io/helloqiu/online-explorer
```  

## module  
``` node
var Explorer = require('online-explorer')
var explorer = new Explorer(host, port, path)
explorer.run()
```

# ScreenShot
![screenshot-1](/screenshot/screenshot.png?raw=true "screenshot-1")
![screenshot-2](/screenshot/screenshot-search.png?raw=true "screenshot-2")  

# License  
MIT

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