jempiere / Serve

My Express Server Liblet

Serve

Welcome to Serve!

Hi! Welcome to Serve, my Express Server Template bundle.

If you, like me, are sick and tired of dealing with writing an Express server every time you want to host your code (Damn CORS errors!), then you are NOT ALONE. With this template, you can simply drop your files into rsc (there are some starter files there for you) and get started!

What is Serve?

Serve is a simple webserver setup. You run node index.mjs and you'll have a parent server running @ localhost:3000, and at the click of a button a child server @ localhost:2500!

Dependencies

Besides vanilla Node.js with ES6 syntax, Serve also depends on the node modulesexpress, compression, toml and socket.io. You can install those with:

npm i express compression socket.io toml. You cannot simply use npm install because Serve makes use of ES6 dynamic imports.

Getting Started

Getting started with Serve is super easy! Just note a few things:

• The default settings for Serve to use are in serve_conf.toml. These can be changed without much fuss, but you'll have to manually change the <iframe> address in src/index.html to your new port. I may decide to have this code statically generated on program run instead, but until then this'll do.

• In the rsc directory, there are a few default files. All of the code in these files -- the <script> and <button> tags in index.html, the var io in script.mjs, and the button#kill rules in style.css are all crucial to be able to shut down the child server. If you wish to do so with the command line instead, you may run this command to kill the child process:

function kill_port(){
  kill -9 $(lsof -t -i:$1)
}

# USAGE:
# $ kill_port 3000
# > *kills processes on port 3000*

• This function is a zsh function, but it should be posix so feel free to run it in other places as well (fish,bash,sh, etc)