fastify-example-ts
Example webapp with Fastify, made in TypeScript
Setup and run
To complete project setup, do:
npm install
then run tests (optional):
npm test
then do a build of TypeScript code (results in the './dist' folder):
npm run build
last, run with
npm start
otherwise perform a build and start with:
npm run start:dev
then point your browser to localhost:8000
Setup and run with Docker
Note that it's possible to let Docker do all inside a container, because all is described in a Dockerfile; see Dockerfile-usage for related commands.
Of course you need a local installation of Docker (recent, if possible latest), but nothing other.
Others
To run a development server (with hot reload enabled) instead execute this:
npm run start:dev
For other custom commands look the 'scripts' section inside 'package.json'.
Requirements
Fastify ^4.0.0, Node.js 14 LTS (14.15.0) or higher.
Note
Some features can be configured via environment variables;
if a .env
file is found in project root, all its contents
will be loaded into environmental variables.
Supported variables:
FASTIFY_OPTIONS
, set Fastify main options at startup, as a JSON string; to change logging level for example use something like: `{ "logger": { "level": "debug" } }' and to remove logging for example use: '{ }'HTTP_PORT
, set default HTTP port for the serverHTTP_ADDRESS
, set default HTTP address for the serverNATS_SERVER_URL
, set the URL for the NATS server (if enabled), or plugin defaultWEBHOOK_SECRET_KEY
, set the secret key to require by exposed webhookFEATURE_PLATFORM_INFO_DISABLE
, to disable the logging of some info related to the current runtime platform like: Node.js version, OS name, Fastify version, Webapp version, etc ...FEATURE_CHECK_RUNTIME_ENV_DISABLE
, to disable (not load) related plugin; if enabled and current Node.js environment is not compatible with the one set in 'package.json' by default it will throw an exception, so the webapp will crash (to avoid running the webapp in a not compliant env)FEATURE_FAVICON_DISABLE
, to disable (not load) related pluginFEATURE_WEBHOOK_DISABLE
, to disable (not load) related pluginFEATURE_HEALTHCHECK_DISABLE
, to disable (not load) related pluginFEATURE_CLOUDEVENTS_DISABLE
, to disable (not load) related plugin; note that this by default uses a public NATS server so disable it if not needed or if that server is not reachable for corporate firewall policiesFEATURE_CLOUDEVENTS_STRICT_DISABLE
, to disable strict mode in generated CloudEvents (if/when related plugin is enabled)FEATURE_CLOUDEVENTS_LOG_CONSOLE_DISABLE
, to disable CloudEvent serialization to consoleFEATURE_CLOUDEVENTS_LOG_FILE_DISABLE
, to disable CloudEvent serialization to console, by default true (so disabled); note that when enabled a new log file will be created at any run of the server, but previous (if present) will be overwritten, so any new run is fresh and old logs will be discardedFEATURE_NATS_DISABLE
, to disable (not load) related plugin if not specified default behavior will be applied.
As a sample, by default (unless disabled) some messages will be sent to a NATS queue, when the web application has started and when a client ask for a page. NATS server by default (in related plugin) is a public one, demo.nats.io.
License
Licensed under Apache-2.0.