@chriscalo/start-server

Simple utility for starting an express server with automatic port selection.

Usage no npm install needed!

<script type="module">
  import chriscaloStartServer from 'https://cdn.skypack.dev/@chriscalo/start-server';
</script>

README

@chriscalo/start-server

DEPRECATED. See express-start

Simple utility for starting an express server with automatic port selection.

Installation:

npm install @chriscalo/start-server
# or
yarn add @chriscalo/start-server

Usage:

const express = require("express");
const { start } = require("@chriscalo/start-server");

const server = express();

server.get("/", (req, res) => {
  res.send("Hello, world!");
});

start(server);
// or
start(server, 3000);

The logic for selecting a port is as follows:

  1. if process.env.PORT is defined, it tries that port and fails if it's not available
  2. the port parameter in start(server, port) defaults to 8000 when a falsy value or no value is provided
  3. it first tries to listen on port, incrementing it until one is found that is available (8001, 8002, 8003, etc)

Example output:

App listening on port 8000
Press Ctrl+C to quit.