instantly_http

Tool to instantly create your own http server for development-use

Usage no npm install needed!

<script type="module">
  import instantlyHttp from 'https://cdn.skypack.dev/instantly_http';
</script>

README

General introduction

With this tool it becomes possible to start a http server instantly via command-line. It provides you ability to test single page application or static web files with a real http server with tiny effort.

Options

  • port

    • Default: 9090
    • Example: --port=9090
    • Explain: To point which port to use as the server address.

  • dir

    • Default: Current directory
    • Example: --dir=c:/abc
    • Explain: To point which directory to serve as the server base directory.

  • proxyPattern

    • Default: undefined
    • Example: --proxyPattern=/proxy
    • Explain: Which pattern to be used as to determinate which request to proxyTarget.

  • proxyTarget

    • Default: undefined
    • Example: --proxyTarget=http://google.com
    • Explain: Which target to redirect when request path matches with proxyPattern.

  • open

    • Default: true
    • Example: --open=false
    • Explain: If not set (true) then the application will try to launch your Chrome installed with the server addresse.g http://localhost:9090.

  • mode

    • Default: NORMAL
    • Example: --mode=SPA
    • Explain: "NORMAL" mode works most likely a http file explorer, it provides very basic function for like list files and resource existence check. "SPA" mode works just like your real SPA http server, that it will redirect request to specific default resource (index.html) if given resource url is not found.

  • indexFile

    • Default: index.html
    • Example: --indexFile=myindex.html
    • Explain: See "mode" options.

  • quiet

    • Default: true
    • Example: --quiet=false
    • Explain: Setting it to false then you will see more debug outputs.

How to run

Examples:

  • In repository

    node bin.js --open=false --port=8080 --proxyTarget=http://proxy-server:8080 --proxyPattern=/api/*

    This is going to serve the current dir ./ with local port 8080, while all the request under /proxy would be redirected to http://google.com

  • Using under NodeJS-ready environment

    const instantly_http = require('instantly_http');
instant_http --open=false --port=8080 --proxyTarget=http://proxy-server:8080 --proxyPattern=/api/*

    npm -g instant_http is required before that.

  • Using binary

    ./instantHttp  --open=false --port=8080 --proxyTarget=http://google.com --proxyPattern=/proxy

    Check the section Build to know how to get an executable binary

Build

  • pkg is used as the package utility, please check pkg's document in order to build runnable binaries as you want.

    # e.g
npx pkg . --targets=host --output instantHttp
# or
npm run buld