github.com/System-Glitch/goyave/v2@v2.10.3-0.20200819142921-51011e75d504/docs_src/src/guide/README.md (about)

     1  ---
     2  meta:
     3    - name: "og:title"
     4      content: "Introduction - Goyave"
     5    - name: "twitter:title"
     6      content: "Introduction - Goyave"
     7    - name: "title"
     8      content: "Introduction - Goyave"
     9  ---
    10  
    11  # Introduction
    12  
    13  Welcome to the Goyave documentation!
    14  
    15  This documentation is both a guide and a reference for Goyave application building. You will find instructions covering the basics as well as more advanced topics, from project setup to deployment. But first, let's talk about the framework itself.
    16  
    17  Goyave is a Golang web API framework aiming at **cleanliness**, **fast development** and **power**. Goyave applications stay clean and concise thanks to minimalist function calls and route handlers. The framework gives you all the tools to create an easily readable and maintainable web application, which let you concentrate on the business logic. Although Goyave handles many things for you, such as headers or marshaling, this characteristic doesn't compromise on your freedom of code.
    18  
    19  Most golang frameworks for web development don't have a strong directory structure nor conventions to make applications have a uniform architecture and limit redundancy. This makes it difficult to work with them on different projects. In companies, having a well-defined and documented architecture helps new developers integrate projects faster, and reduces the time needed for maintaining them. For open source projects, it helps newcomers understanding the project and makes it easier to contribute. With Goyave, expect a full package with minimum setup.
    20  
    21  ::: tip Note
    22  Please feel free to sudgest changes, ask for more details, report grammar errors, or notice of uncovered scenarios by [creating an issue](https://github.com/System-Glitch/goyave/issues/new/choose) with the proposal template.
    23  :::
    24  
    25  ::: img-row <img :src="$withBase('/undraw_to_do_list_a49b.svg')" height="150" alt="Roadmap"/>
    26  ### Ideas for future releases
    27  
    28  - Permission system (guards)
    29  - CLI utility to help creating controllers, middleware, etc
    30  - Direct support for the HEAD method
    31  - Email helpers
    32  - Queues/Scheduler system
    33  - OpenAPI generator
    34  - And more!
    35  :::
    36  
    37  ## Contributors
    38  
    39  A big "Thank you" to the Goyave contributors:
    40  
    41  - [Kuinox](https://github.com/Kuinox) (Powershell install script)
    42  - [Alexandre GV.](https://github.com/alexandregv) (Install script MacOS compatibility)
    43  - [jRimbault](https://github.com/jRimbault) (CI and code analysis)