Softsuite

Thanks to Cozy (ItsCosmas) to build gofiber boilerplate. I start learning gofiber because of its performance. Also, the following gofiber features could make the great projects.

• Express-inspired
• Robust routing
• Serve static files
• Extreme performance
• API ready
• Flexible middleware support
• Low memory footprint
• Template engine
• Websocket support
• Rate limiter

Running and Developing locally

1. Create .env at src, i.e.

cp src/.env.example src/.env

1. Download Swag for generating docs

go get -u github.com/swaggo/swag/cmd/swag

1. Run

• NOTE: You have to generate swagger docs before running the app.

# Terminal 1
swag init -g src/api/app.go --output ./src/api/docs # Generates Swagger

# Terminal 2
docker-compose --env-file ./src/.env up        # docker-compose up (Run App With AutoReload)
docker-compose --env-file ./src/.env down      # docker-compose down (Shutdown App)

• API http://localhost:8000/api/v1
• Swagger Doc http://localhost:8000/api/v1/docs

Packaging For Production

1. Create .env at src, i.e.

cp src/.env.example src/.env

1. Update your .env variables for production

• Point to your prod database
• Update JWT issuer, secret key , blah blah
• Basically just follow good production practice

1. Download Swag for generating docs

go get -u github.com/swaggo/swag/cmd/swag

• Generate Swagger Docs. You have to generate swagger docs before packaging the app.

swag init -g src/api/app.go --output ./src/api/docs # Generates Swagger

1. Build Your Image

• Permission the build script to run.

chmod +x docker-build.sh

• You could set the image port on Dockerfile.prod
• Run the build script. You must provide a version tag as shown below.

./docker-build.sh -v gofiber:1.0.0