goyave.dev/goyave/v5@v5.0.0-rc9.0.20240517145003-d3f977d0b9f3/README.md (about) 1 <p align="center"> 2 <img src="https://raw.githubusercontent.com/go-goyave/goyave/master/resources/img/logo/goyave_text.png#gh-light-mode-only" alt="Goyave Logo" width="550"/> 3 <img src="https://raw.githubusercontent.com/go-goyave/goyave/master/resources/img/logo/goyave_text_dark.png#gh-dark-mode-only" alt="Goyave Logo" width="550"/> 4 </p> 5 6 <p align="center"> 7 <a href="https://github.com/go-goyave/goyave/releases"><img src="https://img.shields.io/github/v/release/go-goyave/goyave?include_prereleases" alt="Version"/></a> 8 <a href="https://github.com/go-goyave/goyave/actions"><img src="https://github.com/go-goyave/goyave/workflows/CI/badge.svg?branch=develop" alt="Build Status"/></a> 9 <a href="https://coveralls.io/github/go-goyave/goyave?branch=master"><img src="https://coveralls.io/repos/github/go-goyave/goyave/badge.svg" alt="Coverage Status"/></a> 10 <a href="https://github.com/avelino/awesome-go"><img src="https://awesome.re/mentioned-badge.svg" alt="Awesome"/></a> 11 </p> 12 13 <p align="center"> 14 <a href="https://github.com/go-goyave/goyave/blob/master/LICENSE"><img src="https://img.shields.io/dub/l/vibe-d.svg" alt="License"/></a> 15 <a href="https://pkg.go.dev/goyave.dev/goyave/v5"><img src="https://pkg.go.dev/badge/goyave.dev/goyave/v5.svg" alt="Go Reference"></a> 16 <a href="https://discord.gg/mfemDMc"><img src="https://img.shields.io/discord/744264895209537617?logo=discord" alt="Discord"/></a> 17 </p> 18 19 ## The enterprise REST API framework 20 21 **Goyave** an **opinionated** all-in-one Golang web framework focused on **REST APIs**, with emphasis on code **reliability**, **maintainability** and **developer experience** (DX). 22 23 In short, Goyave's **goals** are: 24 - Catering to companies with enterprise-level clean architecture, for medium to large projects 25 - Help developers focus on the business logic of their application instead of spending time on technical aspects 26 - Provide an all-in-one package with no setup friction 27 - Provide all the features a typical project needs without bloating or magic 28 - Provide an optimal setup for the real-world 29 - Ensure robust, reliable and resilient code 30 - Stay open and hackable despite being opinionated 31 - Make backend development easy and enjoyable 32 - Keep a clear and extensive documentation so developers can always find the answer to their questions 33 34 Goyave's **non-goals** are: 35 - Hyper-optimisation and performance 36 - Small projects and prototypes 37 - Providing control on low-level networking 38 - Providing tools for front-end development 39 40 If you feel like the above description fits your needs, **welcome**! Feel free to read the full documentation on [goyave.dev](https://goyave.dev/). This website contains the **documentation** and **guides** on how to use the framework to its fullest, so you can start creating value for your business. 41 42 You can also take a look at the [example project](https://github.com/go-goyave/goyave-blog-example). 43 44 ## Features 45 46 Routing, Controllers, Middleware, Request parsing, Advanced validation, Business transactions, Authentication, Configuration, Testing utilities, Database support and ORM, Localization, Advanced error handling, Structured logging, CORS, Support for file systems, Websockets, Dynamic filtering and pagination using query parameters, DTO conversion and model mapping, and the list goes on... 47 48 If you want to learn more, all features are documented on [goyave.dev](https://goyave.dev/). 49 50 ## Contributing 51 52 Thank you for considering contributing to the Goyave framework! You can find the contribution guide in the [documentation](https://goyave.dev/contributing.html). 53 54 For financial support, you can support me on Github Sponsor: [❤ Sponsor me!](https://github.com/sponsors/System-Glitch) 55 56 I'm very grateful to my patrons, sponsors and donators: 57 58 - Ben Hyrman 59 - Massimiliano Bertinetti 60 - ethicnology 61 - Yariya 62 - sebastien-d-me 63 - Nebojša Koturović 64 65 ### Contributors 66 67 A big "Thank you" to the Goyave contributors: 68 69 - [Kuinox](https://github.com/Kuinox) (Powershell install script) 70 - [Alexandre GV.](https://github.com/alexandregv) (Install script MacOS compatibility) 71 - [jRimbault](https://github.com/jRimbault) (CI and code analysis) 72 - [Guillermo Galvan](https://github.com/gmgalvan) (Request extra data) 73 - [Albert Shirima](https://github.com/agbaraka) (Rate limiting and various contributions) 74 - [Łukasz Sowa](https://github.com/Morishiri) (Custom claims in JWT) 75 - [Zao SOULA](https://github.com/zaosoula) (Custom `gorm.Config{}` in config file) 76 - [Ajtene Kurtaliqi](https://github.com/akurtaliqi) (Documentation landing page) 77 - [Louis Laurent](https://github.com/ulphidius) ([`gyv`](https://github.com/go-goyave/gyv) productivity CLI) 78 - [Clement3](https://github.com/Clement3) (`search` feature on [`goyave.dev/filter`](https://github.com/go-goyave/filter)) 79 - [Darkweak](https://github.com/darkweak) (`HTTP cache, RFC compliant` middleware based on [Souin HTTP cache system](https://github.com/darkweak/souin)) 80 - [Jason C Keller](https://github.com/imuni4fun) (Testify interface compatibility) 81 82 ## License 83 84 The Goyave framework is MIT Licensed. Copyright © 2024 Jérémy LAMBERT (SystemGlitch)