Skip to content

A kickass πŸ’ͺ web server πŸ™€ with all the bells πŸ”” and whistles ✨

License

Notifications You must be signed in to change notification settings

hfreire/serverful

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

A kickass πŸ’ͺ web server πŸ™€ with all the bells πŸ”” and whistles ✨

Coverage Status Known Vulnerabilities Version Downloads

Uses hapi loaded with most important plugins (Boom, Vision, Inert, et al.) and dynamically configures your routes

Features

How to install

npm install serverful

How to use

Use it in your app

Load module and start a server

const Serverful = require('serverful')

const server = new Serverful()
server.start()

Available environment variables

Variable Description Required Default value
NAME The name of the app. false undefined
VERSION The version of the app. false undefined
PORT The port to be used by the HTTP server. false 3000
API_KEYS The secret keys that should be used when securing endpoints. false undefined
SO_TIMEOUT TCP socket connection timeout. false 120000
BASE_PATH Base path to be prefixed to all available endpoint paths. false /
PING_PATH Endpoint path for pinging app. false /ping
HEALTHCHECK_PATH Endpoint for checking app health. false /healthcheck
LOG_LEVEL The log level verbosity. false info
ENVIRONMENT The environment the app is running on. false undefined
ROLLBAR_API_KEY The server API key used to talk with Rollbar. false undefined

How to contribute

You can contribute either with code (e.g., new features, bug fixes and documentation) or by donating 5 EUR. You can read the contributing guidelines for instructions on how to contribute with code.

All donation proceedings will go to the Sverige fΓΆr UNHCR, a swedish partner of the UNHCR - The UN Refugee Agency, a global organisation dedicated to saving lives, protecting rights and building a better future for refugees, forcibly displaced communities and stateless people.

Used by

  • get-me-a-date - 😍 Help me get a πŸ’˜ date tonight πŸŒ›
  • watch-rtp-play - πŸ“Ί Watch and πŸ“» listen πŸ‡΅πŸ‡Ή RTP Play without a πŸ’» browser
  • browser-as-a-service - A web browser 🌎 hosted as a service, to render your JavaScript web pages as HTML
  • my-flic-hub - My own flic hub ℒ️ for the 🌍 world's smartest πŸ”΄ button

License

Read the license for permissions and limitations.