fastify-typescript-boilerplate v1.0.30

Fastify TypeScript Boilerplate

Fastify TypeScript Boilerplate with features like JWT Authentication, Swagger, CORS, Static Files, Redis, Mongoose, Socket.io, Node Schedule, Pino Logger, PM2, Nodemon, and more!

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js
• npm
• Redis
• MongoDB

Additional

• If you're going to start the project in the docker, It downloads the Redis and MongoDB and connects.

Installation

1. Clone the repository

git clone https://github.com/TheAlpiz/fastify-typescript-boilerplate.git

2. Change the working directory

cd fastify-typescript-boilerplate

3. Install dependencies

npm install

Development

Run the app in development mode

1. npm run dev:node 
2. npm run dev:pm2

Production

Run the app in production mode

npm run start:node
npm run start:pm2

For Docker

Production

npm run start:docker

Development

npm run dev:docker 

Features

Fastify:

Fast and low overhead web framework for Node.js.

TypeScript:

Superset of JavaScript which primarily provides optional static typing, classes, and interfaces.

JWT:

Implementation of JSON Web Tokens.

Swagger:

Interactive API documentation.

CORS:

Cross-Origin Resource Sharing.

Static Files:

Serving static files using Fastify.

Redis:

In-memory data structure store, used as a database, cache, and message broker.

Mongoose:

Elegant MongoDB object modeling for Node.js.

Socket.io:

Real-time bidirectional event-based communication.

Node Schedule:

Node.js job scheduler.

Pino Logger:

Extremely fast Node.js logger.

PM2:

Advanced production process manager for Node.js.

Nodemon:

Utility that monitors for any changes in your source and automatically restarts your server.

Docker:

Docker is a set of platform as a service products that use OS-level virtualization to deliver software in packages called containers.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.