Skip to content

Commit

Permalink
Add docs from gofiber/recipes@6dbfc60
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 27, 2024
1 parent 5750a9b commit c95985d
Show file tree
Hide file tree
Showing 80 changed files with 166 additions and 88 deletions.
1 change: 1 addition & 0 deletions docs/recipes/404-handler/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: 404 Handler
keywords: [404, not found, handler, errorhandler, custom]
description: Custom 404 error page handling.
---

# Custom 404 Not Found Handler Example
Expand Down
160 changes: 80 additions & 80 deletions docs/recipes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 👋 Overview
sidebar_position: 1
---

# 🍳 Examples for [Fiber](https://github.com/gofiber/fiber)
# 🍳 Recipes for [Fiber](https://github.com/gofiber/fiber)

**Welcome to the official Fiber cookbook**!

Expand All @@ -13,85 +13,85 @@ Here you can find the most **delicious** recipes to cook delicious meals using o
## 🌽 Table of contents

<!-- AUTO-GENERATED-CONTENT:START -->
- [404 Handler](./404-handler/README.md)
- [Air Live Reloading](./air/README.md)
- [Auth + Docker + Postgres + JWT](./auth-docker-postgres-jwt/README.md)
- [Auth + JWT](./auth-jwt/README.md)
- [Autocert](./autocert/README.md)
- [AWS Elastic Beanstalk](./aws-eb/README.md)
- [AWS SAM](./aws-sam/README.md)
- [AWS SAM Container](./aws-sam-container/README.md)
- [Bootstrap](./bootstrap/README.md)
- [Clean Architecture](./clean-architecture/README.md)
- [Cloud Run](./cloud-run/README.md)
- [Colly Gorm](./colly-gorm/README.md)
- [CSRF](./csrf/README.md)
- [CSRF + Session](./csrf-with-session/README.md)
- [Docker + MariaDB](./docker-mariadb-clean-arch/README.md)
- [Docker + Nginx](./docker-nginx-loadbalancer/README.md)
- [Dummy JSON Proxy](./dummyjson/README.md)
- [Entgo ORM (MySQL)](./ent-mysql/README.md)
- [Entgo Sveltekit](./entgo-sveltekit/README.md)
- [Envoy External Authorization](./envoy-extauthz/README.md)
- [File Server](./file-server/README.md)
- [Firebase Authentication](./firebase-auth/README.md)
- [Firebase Functions](./firebase-functions/README.md)
- [Firebase GCloud](./gcloud/README.md)
- [Google Cloud Firebase](./gcloud-firebase/README.md)
- [GeoIP](./geoip/README.md)
- [GeoIP + MaxMind](./geoip-maxmind/README.md)
- [GORM](./gorm/README.md)
- [GORM MySQL](./gorm-mysql/README.md)
- [GORM + PostgreSQL](./gorm-postgres/README.md)
- [Graceful shutdown](./graceful-shutdown/README.md)
- [GraphQL](./graphql/README.md)
- [gRPC](./grpc/README.md)
- [Hello World](./hello-world/README.md)
- [Heroku](./heroku/README.md)
- [Hexagonal Architecture](./hexagonal/README.md)
- [HTTPS with PKCS12 TLS](./https-pkcs12-tls/README.md)
- [HTTPS with TLS](./https-tls/README.md)
- [I18n](./i18n/README.md)
- [JWT](./jwt/README.md)
- [Kubernetes](./k8s/README.md)
- [Memgraph](./memgraph/README.md)
- [MinIO](./minio/README.md)
- [MongoDB Example](./mongodb/README.md)
- [Multiple Ports](./multiple-ports/README.md)
- [MySQL](./mysql/README.md)
- [Neo4j](./neo4j/README.md)
- [OAuth2](./oauth2/README.md)
- [Google OAuth2](./oauth2-google/README.md)
- [Optional Parameter Example](./optional-parameter/README.md)
- [Parsley](./parsley/README.md)
- [PostgreSQL](./postgresql/README.md)
- [Prefork Example](./prefork/README.md)
- [RabbitMQ](./rabbitmq/README.md)
- [React](./react-router/README.md)
- [Recover Middleware Example](./recover/README.md)
- [RSS Feed](./rss-feed/README.md)
- [Server Timing](./server-timing/README.md)
- [Sessions + SQLite3](./sessions-sqlite3/README.md)
- [Socketio](./socketio/README.md)
- [Single Page Application (SPA)](./spa/README.md)
- [Sqlboiler](./sqlboiler/README.md)
- [Sqlc](./sqlc/README.md)
- [Server-Sent Events](./sse/README.md)
- [Stream Request Body](./stream-request-body/README.md)
- [Svelte Netlify](./svelte-netlify/README.md)
- [Sveltekit Embed](./sveltekit-embed/README.md)
- [Swagger](./swagger/README.md)
- [Tableflip Example](./tableflip/README.md)
- [Template](./template/README.md)
- [Template Asset Bundling](./template-asset-bundling/README.md)
- [Todo App + Auth + GORM](./todo-app-with-auth-gorm/README.md)
- [Unit Testing](./unit-test/README.md)
- [File Upload](./upload-file/README.md)
- [URL Shortener](./url-shortener-api/README.md)
- [Validation](./validation/README.md)
- [Vercel](./vercel/README.md)
- [WebSocket](./websocket/README.md)
- [WebSocket Chat](./websocket-chat/README.md)
- [404 Handler](./404-handler/README.md) - Custom 404 error page handling.
- [Air Live Reloading](./air/README.md) - Live reloading for Go applications.
- [Auth + Docker + Postgres + JWT](./auth-docker-postgres-jwt/README.md) - Authentication with Docker, Postgres, and JWT.
- [Auth + JWT](./auth-jwt/README.md) - Simple JWT authentication.
- [Autocert](./autocert/README.md) - Automatic TLS certificate management.
- [AWS Elastic Beanstalk](./aws-eb/README.md) - Deploying to AWS Elastic Beanstalk.
- [AWS SAM](./aws-sam/README.md) - Serverless applications with AWS SAM.
- [AWS SAM Container](./aws-sam-container/README.md) - Containerized serverless applications with AWS SAM.
- [Bootstrap](./bootstrap/README.md) - Integrating Bootstrap.
- [Clean Architecture](./clean-architecture/README.md) - Implementing clean architecture in Go.
- [Cloud Run](./cloud-run/README.md) - Deploying to Google Cloud Run.
- [Colly Gorm](./colly-gorm/README.md) - Web scraping with Colly and GORM.
- [CSRF](./csrf/README.md) - Cross-Site Request Forgery (CSRF) protection.
- [CSRF + Session](./csrf-with-session/README.md) - Cross-Site Request Forgery (CSRF) protection with session management.
- [Docker + MariaDB](./docker-mariadb-clean-arch/README.md) - Dockerized MariaDB with Clean Architecture.
- [Docker + Nginx](./docker-nginx-loadbalancer/README.md) - Load balancing with Docker and Nginx.
- [Dummy JSON Proxy](./dummyjson/README.md) - Proxying dummy JSON data.
- [Entgo ORM (MySQL)](./ent-mysql/README.md) - Using Entgo ORM with MySQL
- [Entgo Sveltekit](./entgo-sveltekit/README.md) - A full-stack Todo application built using Sveltekit, Tailwind CSS, Entgo, and SQLite.
- [Envoy External Authorization](./envoy-extauthz/README.md) - External authorization with Envoy.
- [File Server](./file-server/README.md) - Serving static files.
- [Firebase Authentication](./firebase-auth/README.md) - Firebase authentication integration.
- [Firebase Functions](./firebase-functions/README.md) - Using Firebase Functions.
- [Firebase GCloud](./gcloud/README.md) - Integrating Firebase with Google Cloud.
- [Google Cloud Firebase](./gcloud-firebase/README.md) - Firebase services on Google Cloud.
- [GeoIP](./geoip/README.md) - Geolocation with GeoIP.
- [GeoIP + MaxMind](./geoip-maxmind/README.md) - Geolocation with GeoIP and MaxMind databases.
- [GORM](./gorm/README.md) - Using GORM with SQLite database.
- [GORM MySQL](./gorm-mysql/README.md) - Using GORM with MySQL database.
- [GORM + PostgreSQL](./gorm-postgres/README.md) - Using GORM with PostgreSQL database.
- [Graceful shutdown](./graceful-shutdown/README.md) - Graceful shutdown of applications.
- [GraphQL](./graphql/README.md) - Setting up a GraphQL server.
- [gRPC](./grpc/README.md) - Using Fiber as a client to a gRPC server.
- [Hello World](./hello-world/README.md) - A simple "Hello, World!" application.
- [Heroku](./heroku/README.md) - Deploying to Heroku.
- [Hexagonal Architecture](./hexagonal/README.md) - A Hexagonal Software Architecture in Golang and MongoDB.
- [HTTPS with PKCS12 TLS](./https-pkcs12-tls/README.md) - Setting up an HTTPS server with PKCS12 TLS certificates.
- [HTTPS with TLS](./https-tls/README.md) - Setting up an HTTPS server with self-signed TLS certificates.
- [I18n](./i18n/README.md) - Internationalization support.
- [JWT](./jwt/README.md) - Using JSON Web Tokens (JWT) for authentication.
- [Kubernetes](./k8s/README.md) - Deploying applications to Kubernetes.
- [Memgraph](./memgraph/README.md) - Using Memgraph.
- [MinIO](./minio/README.md) - A simple application for uploading and downloading files from MinIO.
- [MongoDB](./mongodb/README.md) - Connecting to a MongoDB database.
- [Multiple Ports](./multiple-ports/README.md) - Running an application on multiple ports.
- [MySQL](./mysql/README.md) - Connecting to a MySQL database.
- [Neo4j](./neo4j/README.md) - Connecting to a Neo4j database.
- [OAuth2](./oauth2/README.md) - Implementing OAuth2 authentication.
- [Google OAuth2](./oauth2-google/README.md) - Implementing Google OAuth2 authentication.
- [Optional Parameter](./optional-parameter/README.md) - Handling optional parameters.
- [Parsley](./parsley/README.md) - Using Parsley for dependency injection in an application.
- [PostgreSQL](./postgresql/README.md) - Connecting to a PostgreSQL database.
- [Prefork](./prefork/README.md) - Running an application in prefork mode.
- [RabbitMQ](./rabbitmq/README.md) - Using RabbitMQ.
- [React](./react-router/README.md) - Using React.
- [Recover Middleware](./recover/README.md) - Recover middleware for error handling.
- [RSS Feed](./rss-feed/README.md) - Generating an RSS feed.
- [Server Timing](./server-timing/README.md) - Adding Server Timing headers to an application.
- [Sessions + SQLite3](./sessions-sqlite3/README.md) - Using SQLite3 as a storage engine for user sessions.
- [Socketio](./socketio/README.md) - A chatroom application using Socket.IO.
- [Single Page Application (SPA)](./spa/README.md) - Setting up a Single Page Application (SPA) using React for the frontend and Go for the backend.
- [Sqlboiler](./sqlboiler/README.md) - Using Sqlboiler ORM.
- [Sqlc](./sqlc/README.md) - Using Sqlc to generate Go code from SQL queries.
- [Server-Sent Events](./sse/README.md) - Implementing Server-Sent Events in an application.
- [Stream Request Body](./stream-request-body/README.md) - Streaming request bodies.
- [Svelte Netlify](./svelte-netlify/README.md) - Deploying a Svelte application on Netlify.
- [Sveltekit Embed](./sveltekit-embed/README.md) - A full-stack application built using Sveltekit and Tailwind CSS.
- [Swagger](./swagger/README.md) - Generate Swagger documentation for your application.
- [Tableflip Example](./tableflip/README.md) - Use tableflip for graceful upgrades in a Go application.
- [Template](./template/README.md) - Setting up a Go application with template rendering.
- [Template Asset Bundling](./template-asset-bundling/README.md) - Setting up a Go application with template rendering and asset bundling.
- [Todo App + Auth + GORM](./todo-app-with-auth-gorm/README.md) - A Todo application with authentication using GORM.
- [Unit Testing](./unit-test/README.md) - Writing unit tests for a Go Fiber application.
- [File Upload](./upload-file/README.md) - Handling file uploads in a Go application.
- [URL Shortener](./url-shortener-api/README.md) - URL shortening service with a simple API.
- [Validation](./validation/README.md) - Input validation using go-playground/validator.
- [Vercel](./vercel/README.md) - Deploy a Go application to Vercel.
- [WebSocket](./websocket/README.md) - Real-time communication application using WebSockets.
- [WebSocket Chat](./websocket-chat/README.md) - Real-time chat application using WebSockets.
<!-- AUTO-GENERATED-CONTENT:END -->

## 👩‍🍳 Have a delicious recipe?
Expand Down
7 changes: 4 additions & 3 deletions docs/recipes/air/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: Air Live Reloading
keywords: [air, live reloading, development, air tool, hot reload, watch, changes]
description: Live reloading for Go applications.
---

# Live Reloading with Air Example

[![Github](https://img.shields.io/static/v1?label=&message=Github&color=2ea44f&style=for-the-badge&logo=github)](https://github.com/gofiber/recipes/tree/master/air) [![StackBlitz](https://img.shields.io/static/v1?label=&message=StackBlitz&color=2ea44f&style=for-the-badge&logo=StackBlitz)](https://stackblitz.com/github/gofiber/recipes/tree/master/air)

This example demonstrates how to set up live reloading for a Go application using the [Air](https://github.com/cosmtrek/air) tool. The purpose of this example is to show how to automatically reload your application during development whenever you make changes to the source code.
This example demonstrates how to set up live reloading for a Go application using the [Air](https://github.com/air-verse/air) tool. The purpose of this example is to show how to automatically reload your application during development whenever you make changes to the source code.

## Description

Expand All @@ -17,7 +18,7 @@ Live reloading is a useful feature during development as it saves time by automa

- [Go](https://golang.org/dl/) 1.18 or higher
- [Git](https://git-scm.com/downloads)
- [Air](https://github.com/cosmtrek/air)
- [Air](https://github.com/air-verse/air)

## Setup

Expand Down Expand Up @@ -93,6 +94,6 @@ This example provides a basic setup for live reloading a Go application using Ai

## References

- [Air Documentation](https://github.com/cosmtrek/air)
- [Air Documentation](https://github.com/air-verse/air)
- [Fiber Documentation](https://docs.gofiber.io)
- [GitHub Repository](https://github.com/gofiber/fiber)
1 change: 1 addition & 0 deletions docs/recipes/auth-docker-postgres-jwt/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Auth + Docker + Postgres + JWT
keywords: [auth, docker, postgres, jwt]
description: Authentication with Docker, Postgres, and JWT.
---

# Auth Docker Postgres JWT Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/auth-jwt/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Auth + JWT
keywords: [auth, jwt, gorm, fiber]
description: Simple JWT authentication.
---

# Auth JWT Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/autocert/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Autocert
keywords: [autocert, tls, letsencrypt, ssl, https, certificate]
description: Automatic TLS certificate management.
---

# Autocert Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/aws-eb/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: AWS Elastic Beanstalk
keywords: [aws, elastic beanstalk, deploy, amazon, aws-eb]
description: Deploying to AWS Elastic Beanstalk.
---

# AWS Elastic Beanstalk Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/aws-sam-container/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: AWS SAM Container
keywords: [aws, sam, serverless, lambda, container]
description: Containerized serverless applications with AWS SAM.
---

# AWS SAM Container
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/aws-sam/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: AWS SAM
keywords: [aws, sam, serverless, lambda]
description: Serverless applications with AWS SAM.
---

# AWS SAM
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/bootstrap/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Bootstrap
keywords: [bootstrap, gorm, validator, env]
description: Integrating Bootstrap.
---

# Bootstrap
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/clean-architecture/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Clean Architecture
keywords: [clean, architecture, fiber, mongodb, go]
description: Implementing clean architecture in Go.
---

# Clean Architecture Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/cloud-run/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Cloud Run
keywords: [cloud run, deploy, google, docker, gcp]
description: Deploying to Google Cloud Run.
---

# Cloud Run Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/colly-gorm/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Colly Gorm
keywords: [colly, gorm, postgresql]
description: Web scraping with Colly and GORM.
---

# Simple Web Scraping Colly App with Fiber
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/csrf-with-session/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: CSRF + Session
keywords: [csrf, security, hacking, vulnerability, session]
description: Cross-Site Request Forgery (CSRF) protection with session management.
---

# CSRF-with-session Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/csrf/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: CSRF
keywords: [csrf, security, hacking, vulnerability]
description: Cross-Site Request Forgery (CSRF) protection.
---

# CSRF Examples
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/docker-mariadb-clean-arch/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Docker + MariaDB
keywords: [docker, mariadb, clean architecture, makefile]
description: Dockerized MariaDB with Clean Architecture.
---

# Docker MariaDB Clean Architecture
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/docker-nginx-loadbalancer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Docker + Nginx
keywords: [docker, nginx, loadbalancer, reverse proxy]
description: Load balancing with Docker and Nginx.
---

# Docker + Nginx
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/dummyjson/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Dummy JSON Proxy
keywords: [dummyjson, proxy, json, server]
description: Proxying dummy JSON data.
---

# Simple Fiber Proxy Server
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/ent-mysql/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Entgo ORM (MySQL)
keywords: [ent, mysql, orm, rest]
description: Using Entgo ORM with MySQL
---

# Example ent ORM for fiber with MySQL
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/entgo-sveltekit/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Entgo Sveltekit
keywords: [ent, sveltekit, tailwindcss, sqlite, rest]
description: A full-stack Todo application built using Sveltekit, Tailwind CSS, Entgo, and SQLite.
---

# Todo Application
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/envoy-extauthz/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Envoy External Authorization
keywords: [envoy, external authorization, keyauth]
description: External authorization with Envoy.
---

# Fiber as an Envoy External Authorization HTTP Service
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/file-server/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: File Server
keywords: [file server, static files]
description: Serving static files.
---

# File Server Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/firebase-auth/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Firebase Authentication
keywords: [firebase, authentication, middleware]
description: Firebase authentication integration.
---

# Go Fiber Firebase Authentication Example
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/firebase-functions/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Firebase Functions
keywords: [firebase, functions, deployment, gcloud, cloud]
description: Using Firebase Functions.
---
# Deploying GoFiber Application to Firebase Functions

Expand Down
1 change: 1 addition & 0 deletions docs/recipes/gcloud-firebase/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Google Cloud Firebase
keywords: [firebase, gcloud, cloud run, cloud function, app engine]
description: Firebase services on Google Cloud.
---

# Deploy Fiber to Google Cloud with Firebase
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/gcloud/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Firebase GCloud
keywords: [firebase, gcloud, cloud run, cloud function, app engine]
description: Integrating Firebase with Google Cloud.
---

# Deploy Fiber to Google Cloud with Firebase
Expand Down
Loading

0 comments on commit c95985d

Please sign in to comment.