UNPKG

startserve

Version:

Startserve is an open source command line http server for serving static files.

74 lines (54 loc) 3.79 kB
# Startserve [![GitHub version](http://img.shields.io/badge/version-0.0.5-brightgreen.svg)](https://github.com/hegdeashwin/Startserve/releases) [![Node.js version](http://img.shields.io/badge/Node.js-%3E%200.10-brightgreen.svg)](https://github.com/hegdeashwin/Startserve) [![NPM version](https://badge.fury.io/js/startserve.svg)](http://badge.fury.io/js/startserve) [![Build Status](https://travis-ci.org/hegdeashwin/Startserve.svg?branch=master)](https://travis-ci.org/hegdeashwin/Startserve) [![Dependency Status](https://gemnasium.com/hegdeashwin/Startserve.svg)](https://gemnasium.com/hegdeashwin/Startserve) [![Built with Grunt](http://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) [![License version](http://img.shields.io/badge/License-MIT-red.svg)](https://github.com/hegdeashwin/Startserve#license) An open source command line http server for serving static files. This command line utility allows you to initialize a static file server. It can be used to quickly server static files in case you don't have heavy requirements of using standard web servers like Apache, tomcat etc. Installation ============ Install Startserve with Node Package Manager: ``` npm install -g startserve ``` How to use ========== ``` Usage: startserve [Options] Options: -h, --help output usage information -V, --version output the version number -p, --port <port> specify web server port for accepting connection. Default is 9000 -g, --gateway <path> specify your static directory path. Default is [.] -a, --about about startserve 0.0.5 ``` To launch startserve with default options: ``` startserve ``` Startserve will launch on port ```9000``` with current directory as gateway path. You can specify your server port with ```-p <port>``` option. For E.g.: ``` startserve -p 5000 ``` Author & Contributors ===================== Developed &amp; maintained by author: <b>Ashwin Hegde</b><br> Follow me at: <a href="https://github.com/hegdeashwin" target="_blank">github</a> | <a href="http://in.linkedin.com/in/hegdeashwin" target="_blank">Linkedin</a> | <a href="https://twitter.com/hegdeashwin3" target="_blank">Twitter</a> We really appreciate all kind of contributions. Special thanks to <a href="//github.com/hegdeashwin/Startserve/graphs/contributors" target="_blank">contributors</a> for using and supporting Startserve. To request a feature or you find any typo errors, enhancements or questions; please feel free to post it on following link, or vote for the ones that are already registered. <br>Tracking: <a href="https://github.com/hegdeashwin/Startserve/issues" target="_blank">https://github.com/hegdeashwin/Startserve/issues</a> License ======= The MIT License (MIT) Copyright (c) 2015 Ashwin Hegde Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.