README.md

FiberSeed

REST API Fiber boilerplate

⭐️ Features

• REST API oriented
• Book CRUD example
• middleware
  • compress
  • CORS
  • ETag
  • recover
  • helmet
  • logger (optional)
  • limiter (optional)
• Environment config with .env
• JSON Error handling
• GORM V2
• Docker
• Live reloading (Air or Fresh)
• Testing

⚙️ Usage

You can fork this repo or use Fiberseed as a package

• git clone https://github.com/embedmode/fiberseed.git
• Copy .env.example to .env
• Install postgres or use docker-compose up postgres
• go mod download
• go run .
• Go to localhost:8080

🚧 Development

Check .env file for database variables

# Install postgres or use docker-compose
docker-compose up postgres
go test ./...
air
# or fresh

🐳 Docker

# postgres + server
docker-compose up

# Building and running docker image (you will need postgres)
docker build -t fiberseed .
docker run -d -p 8080:8080 fiberseed

# only postgres
docker-compose up postgres

📜 Changelog

We use GitHub releases.

🔐 Security

To report a security vulnerability, please use the Tidelift security contact.

📄 License

This project is licensed under the terms of the MIT license.