jvm-man / fastify-template-server

Template for spinning up a fastify server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fastify Template Server

Maintenance

Description

A template fastify server with basic functionality and structure ready to fork and spin up a server.

Contents

This repository is ready to start developing. You can find controllers folders where you can register routes and start creating your api.

Inside this repo you can find *.spec test files and a basic *.integration file. In package.json it is specified 100% coverage you can tweak this number to meet your needs.

In the root folder there is also two Dockerfiles, one for development Dockerfile.dev and the Dockerfile for production.

You can find to env file, .env.example. You can run cp .env.example .env and start working locally.

⚠️ .env file is not ported inside Dockerfile

Finally there is a folder /kubernetes containing a basic yaml file for creating a Deployment and Service for running your server in Kubernetes.

Usage

Locally

In order to run this server locally you need to install dependencies with npm install and then npm run start.

Docker

Build Image:

docker build . -t fastify-template
# or the dev image
docker build . -f Dockerfile.dev -t fastify-template

Run Development Image

You can run development Docker and develop your code in two ways

docker run -p <host-port>:<server-port> --name fastify-template fastify-template
# or with live reload support
docker run -p <host-port>:<server-port> --name fastify-template -v /app/node_modules -v ${PWD}:/app fastify-template

Run Production Image

docker run --rm -p <host-port>:<server-port> --name fastify-template fastify-template

Useful Resources

License

MIT License

About

Template for spinning up a fastify server

License:MIT License


Languages

Language:TypeScript 91.9%Language:Dockerfile 4.8%Language:JavaScript 3.0%Language:Shell 0.3%