Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smartiniongithub/fastify-example-ts
Example webapp with Fastify, made in TypeScript
https://github.com/smartiniongithub/fastify-example-ts
docker example fastify hacktoberfest test typescript webapp
Last synced: 6 days ago
JSON representation
Example webapp with Fastify, made in TypeScript
- Host: GitHub
- URL: https://github.com/smartiniongithub/fastify-example-ts
- Owner: smartiniOnGitHub
- License: apache-2.0
- Created: 2020-06-02T10:35:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-28T18:57:33.000Z (almost 2 years ago)
- Last Synced: 2024-12-06T17:24:01.130Z (17 days ago)
- Topics: docker, example, fastify, hacktoberfest, test, typescript, webapp
- Language: TypeScript
- Homepage:
- Size: 172 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fastify-example-ts
[](http://standardjs.com/)
[](https://snyk.io//test/github/smartiniOnGitHub/fastify-example-ts?targetFile=package.json)
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](http://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](./docs/Dockerfile-usage.md)
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 server
- `HTTP_ADDRESS`, set default HTTP address for the server
- `NATS_SERVER_URL`, set the URL for the NATS server (if enabled), or plugin default
- `WEBHOOK_SECRET_KEY`, set the secret key to require by exposed webhook
- `FEATURE_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 plugin
- `FEATURE_WEBHOOK_DISABLE`, to disable (not load) related plugin
- `FEATURE_HEALTHCHECK_DISABLE`, to disable (not load) related plugin
- `FEATURE_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 policies
- `FEATURE_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 console
- `FEATURE_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 discarded
- `FEATURE_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](nats://demo.nats.io:4222).
## License
Licensed under [Apache-2.0](./LICENSE).
----