README.md

Welcome to fastify-starter 👋

Fastify Typescript Starter

Features

• Swagger documentation generator for Fastify https://github.com/fastify/fastify-swagger
• Generates swagger/openapi specification based on jsDoc comments and YAML files. https://github.com/Surnet/swagger-jsdoc
• Mercurius is a GraphQL adapter for Fastify https://mercurius.dev/
• Code-GraphQL Nexus Declarative, Code-First GraphQL Schemas for JavaScript/TypeScript https://nexusjs.org
• Log and tracking with hyperdxio/hyperdx
• And some useful plugins as https://github.com/fastify/fastify-env, https://github.com/fastify/fastify-cors, https://github.com/fastify/fastify-helmet

Install

pnpm install

Usage

pnpm start

Swagger UI

Open below link on your browser with localhost http://localhost:3000/documentation or try with demo server https://fastify-starter.fly.dev/documentation

GraphQL Client IDE

Open below link on your browser with localhost http://localhost:3000/altair or try with demo server https://fastify-starter.fly.dev/altair

GraphQL

If you are new to GraphQL, please watch the below video for more information.

Run below command in your terminal/CLI

curl -H "Content-Type:application/graphql" -XPOST -d "query { hello }" http://localhost:3000/graphql | jq .

Output:

{
  "data": {
    "hello": "Hello World!"
  }
}

Run tests

pnpm test

Pre-commit hooks

This project uses Pre-commit to enforce code quality. You can install it by running:

pre-commit install

Deployment

This template comes with two GitHub Actions that handle automatically deploying your app to production environment.

Prior to your first deployment, you'll need to do a few things:

• Install Fly

• Sign up and log in to Fly

  fly auth signup

• Create a new app on Fly:

  fly create fastify-starter

• Create a new GitHub Repository

• Add a FLY_API_TOKEN to your GitHub repo. To do this, go to your user settings on Fly and create a new token, then add it to your repo secrets with the name FLY_API_TOKEN.

Now that every is set up you can commit and push your changes to your repo. Every commit to your main branch will trigger a deployment to your production environment.

GitHub Actions

We use GitHub Actions for continuous integration and deployment. Anything that gets into the main branch will be deployed to production after running tests/build/etc.

References

• jellydn/platformatic-starter: Platformatic starter template

Author

👤 Huynh Duc Dung

• Website: https://productsway.com/
• Twitter: @jellydn
• Github: @jellydn

Show your support

Give a ⭐️ if this project helped you!