Lightweight webserver for testing and demonstrating front-end projects, running HTTP, HTTPS or HTTP/2.
A limited set of common mime-types is used. When you install the mime-types package next to stream-statics all known mime-types can be used. This way the number of dependencies is limited.
Before setting up a new server, a few checks are made. When the port number is in use or when the root folder can't be found, the startServer function will error.
On first secure run, or when the certificate has expired, a private key and a certificate are generated inside the module folder
Default configuration:
root: './',
protocol: 'http2', // 'http' | 'https' | 'http2'
port: 9630,
Start a server for instance before starting a e2e test
"scripts": {
"...": "...",
"pretest": "stst --port 3001 --protocol http",
"...": "..."
}
On the command line:
npx stst --https --4210 --../../yourProject
...
kill $(lsof -t -i:4210)
In a script:
import { startServer } from 'stream-statics'
const config = {
root: './', // default folderName
protocol: 'http2', // default protocol
port: 9630, // default portNumber
}
const server = await startServer(config) // argument is required for now.
...
const callback = () => console.log(`Connection to localhost:${config.port} was closed`)
server.close(callback)
Run
npm run demo