tsherif / nano-server Goto Github PK

An ultra-lightweight node.js HTTP server for web development.

License: GNU General Public License v3.0

JavaScript 100.00%

nano-server's Introduction

nano-server

nano-server is an ultra-lightweight node.js HTTP server for web development. It exposes a local directory through HTTP, simplifying development of front-end apps that require functionality blocked by cross-origin protections, e.g. AJAX, Canvas Image Processing, Web Audio Analysis, WebGL textures.

nano-server provides some features that I didn't find in similar server packages:

Sends gzipped versions of files, if they are available.
Attempts to set the Content-Type header with the appropriate MIME type for browser-relevant file types.
0 dependencies. Can be dropped into any project.

Usage

The simplest way to install nano-server is as a global install through npm:

  $ npm install -g nano-server

Then nano-server can be invoked as a command line executable:

  $ nano-server

By default, nano-server will run on port 5000 and use the current working directory as its document root. Optionally, a port number can be passed as first argument on the command line:

  $ nano-server 3000

The document root can be given as second argument, if desired.

  $ nano-server 5000 my_app/public_html

Since nano-server has no dependancies, it can be dropped directly into any project and invoked using node explicitly. This can be useful if you don't have the necessary permissions to do a global install on the machine you're using:

  $ cp nano-server ~/path/to/project/
  $ cd ~/path/to/project/
  $ node nano-server

nano-server's People

Contributors

Stargazers

Watchers

Forkers

sunbox adarshniket sebhildebrandt 2pt3 paulmougel imclab steffow myl142857 natacha-beck dfdeagle47 upperhighway ukungzulfah xxczaki themineraria

nano-server's Issues

Default MIME type should be 'application/octet-stream"

It seems some browsers will try to parse files in weird ways when they guess what the file type is (e.g. Firefox tried to read an OBJ file as XML). So having a default that shouldn't be parsed would be best.

Bug in path generation for directory view.

If the directory is nested more than 3 levels, the first level seems to repeat.

Support for live reload?

That would be a great feature.

Files with Spaces are not loaded

I'm finding that files with spaces in the names are not found, whereas the same file renamed with dashes loads fine.

Add / to directories in directory listing.

Otherwise, relative paths don't get built properly.

use node mime module

Don't re-invent the wheel ... use https://github.com/broofa/node-mime for mime type detection. ;)

Using the npm published version of nano-server on a Unix-based system fails

While trying to use nano-server to serve static files for Brain Browser:

$  nano-server 5000 ./examples
env: node\r: No such file or directory

This happens because the files are saved in DOS format (see npm/npm#2097), which unfortunately screws the shebang…

Edit: I tried to fork the repository and fix the line-endings, but it turns out they are fine! Only the files published on npm are messed up. So I guess re-publishing from a UNIX computer should be enough to fix the issue.

For people encountering the same issue, here is how I fixed it.

The package was installed using npm i -g nano-server, so I edited the file where the program was loaded from:

$ vim $(which nano-server)

just enter :set ff=unix, save the file and voilà!

mime type

Hello,

You may want to use:

https://github.com/broofa/node-mime

... for mime type handling. That way, you don't need to maintain getMimeTypes().
-- Thomas

Reduce number of MIME types

Not sure how useful it is to have all the MIME types. Maybe just reducing it to the ones relevant to the browser would be enough (html, js, css, json, etc.).