Code Monkey home page Code Monkey logo

app-serve's Introduction

app-serve

Serve your app for production.

Actions License Donate


Usage

import serve from "app-serve";

/* serve a static directory */
serve("dist");

/* serve with options */
serve({
    contentBase: "dist",
    historyApiFallback: true
});

Options

verbose

Type: boolean Default: true

Show server address in console.

contentBase

Type: string or string[] Default:

Folder(s) to serve files from.

historyApiFallback

Type: boolean or string Default: false

Fallback to serving index.html or the path to fallback on.

host

Type: string Default: localhost

Server host.

port

Type: number Default: 3000

Server port.

https

Type: HTTPSCert Default: false

certs to enable the server to use https, by default uses http.

headers

Type: Object<string, string> Default: {}

Set headers to be used with each request/response

mimeTypes

Type: Object<string, string> Default: {}

Additional mime types to recognize.

onListening

Type: Function Default: null

Execute a functino when the server starts.


Why

When building an app with rollup, its common to use rollup-plugin-serve. This package aims to replicate its functionality outside of rollup for use in production builds. The benefit of this is that your development and production builds will be running in the same http server so you dont have to worry about inconsistancies with other http servers.


Reporting Issues

If you are having trouble getting something to work with app-serve or run into any problems, you can create a new Issue.

If this package does not fit your needs or is missing a feature you would like to see, let us know! We would greatly appreciate your feedback on it.


License

app-serve is licensed under the terms of the MIT license.

app-serve's People

Contributors

jleeson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.