Comparing version 0.9.3 to 0.9.4
{ | ||
"name": "list", | ||
"version": "0.9.3", | ||
"description": "Single-command HTTP directory listing and file serving", | ||
"version": "0.9.4", | ||
"scripts": { | ||
@@ -6,0 +5,0 @@ "start": "gulp", |
# list | ||
**THIS PROJECT IS DEPRECATED. PLEASE USE [THIS ONE](https://www.npmjs.com/package/serve) INSTEAD.** | ||
--- | ||
Ever wanted to share a certain directory on your network by running just a command? Then this module is exactly what you're looking for: It provides a neat interface for listing the directory's contents and switching into sub folders. | ||
In addition, it's also awesome when it comes to serving static sites. If a directory contains an `index.html`, list will automatically render it instead of serving the file's content as plaintext. | ||
<img src="http://i.imgur.com/Fru8ufo.png"> | ||
## Usage | ||
Install it (needs at least node v6) | ||
```bash | ||
$ npm install -g list | ||
``` | ||
Run it | ||
```bash | ||
$ list <path> [options] | ||
``` | ||
You can find a list of all options [below](#options). | ||
### Options | ||
| Usage | Description | Default value | | ||
| ---------------------- | ----------- | ------------------ | | ||
| -h, --help | Output all available options | - | | ||
| -v, --version | The version tag of the list instance on your device | - | | ||
| -p, --port [port] | A custom port on which the app will be running | 3000 | | ||
| -c, --cache [seconds] | How long static files should be cached in the browser | 3600 | | ||
| -s, --single | Serve single page apps with only one `index.html` in the root directory | - | | ||
| -u, --unzipped | Disable gzip compression | false | | ||
| -i, --ignore | Files and directories to ignore | - | | ||
| -a, --auth | Enable HTTP authentication | false | | ||
### Authentication | ||
If you set the `--auth` flag, `list` will look for a username and password in the `LIST_USER` and `LIST_PASSWORD` environment variables. | ||
## Examples | ||
Here's a list of selected sites that are running on `list`: | ||
- [Hyper](https://hyper.is) ([repo](https://github.com/zeit/hyper-website)) | ||
- [Ricky Rauch](https://rickyrauch.me) | ||
## Contribute | ||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device | ||
2. Uninstall list if it's already installed: `npm uninstall -g list` | ||
3. Link it to the global module directory: `npm link` | ||
4. Transpile the source code and watch for changes: `npm start` | ||
Yey! Now can use the `list` command everywhere. [Here](https://github.com/zeit/list/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+for+beginners%22)'s a list of issues that are great for beginners. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
15734
4