Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jellydn/fastify-starter
Fastify starter template support RestAPI with Swagger and Graphql
https://github.com/jellydn/fastify-starter
cors fastify fastify-boilerplate fastify-starter graphql helmet rest-api swagger typescript
Last synced: 25 days ago
JSON representation
Fastify starter template support RestAPI with Swagger and Graphql
- Host: GitHub
- URL: https://github.com/jellydn/fastify-starter
- Owner: jellydn
- License: mit
- Created: 2021-10-23T13:15:28.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T19:08:46.000Z (about 2 months ago)
- Last Synced: 2024-10-29T21:21:51.163Z (about 2 months ago)
- Topics: cors, fastify, fastify-boilerplate, fastify-starter, graphql, helmet, rest-api, swagger, typescript
- Language: TypeScript
- Homepage: https://fastify-starter.fly.dev/documentation/static/index.html
- Size: 5.71 MB
- Stars: 113
- Watchers: 5
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-boilerplate - Github
- awesome-boilerplate - Github
README
# Welcome to fastify-starter 👋
[](#)
[](https://twitter.com/jellydn)
> 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](https://github.com/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
```sh
pnpm install
```
## Usage
```sh
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.
[![IT Man - Talk #27 - GraphQL 2022 Report Insights [Vietnamese]](https://i.ytimg.com/vi/_wmldiEdwPM/hqdefault.jpg)](https://www.youtube.com/watch?v=_wmldiEdwPM)
Run below command in your terminal/CLI
```sh
curl -H "Content-Type:application/graphql" -XPOST -d "query { hello }" http://localhost:3000/graphql | jq .
```
Output:
```
{
"data": {
"hello": "Hello World!"
}
}
```
## Run tests
```sh
pnpm test
```
## Pre-commit hooks
This project uses [Pre-commit](https://pre-commit.com/) to enforce code quality. You can install it by running:
```sh
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](https://fly.io/docs/getting-started/installing-flyctl/)
- Sign up and log in to Fly
```sh
fly auth signup
```
- Create a new app on Fly:
```sh
fly create fastify-starter
```
- Create a new [GitHub Repository](https://repo.new)
- Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-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](https://github.com/jellydn/platformatic-starter)
## Author
👤 **Huynh Duc Dung**
- Website: https://productsway.com/
- Twitter: [@jellydn](https://twitter.com/jellydn)
- Github: [@jellydn](https://github.com/jellydn)
## Show your support
[](https://ko-fi.com/dunghd)
[](https://paypal.me/dunghd)
[](https://www.buymeacoffee.com/dunghd)
Give a ⭐️ if this project helped you!
[](https://github.com/jellydn/fastify-starter/stargazers)