Golang Fiber App Template

A template for building web applications in Golang using the Fiber web framework. Kickstart your web development project with this pre-configured template.

Features

• Fiber Web Framework: Utilizes the popular Fiber web framework for building efficient and fast web applications.
• Structured Directory Layout: Follows a well-organized directory structure for your codebase.
• Docker Support: Easily containerize your application for deployment.
• Configuration Management: Manage your application configuration with ease.
• Database Integration: Incorporates robust database integration to efficiently handle a variety of SQL databases, ensuring seamless data management capabilities.
• Cache Integration: Incorporates robust cache integration to efficiently handle Redis Cache
• Cloud Object Storage Integration: Incorporates robust cloud object storage integration to efficiently handle a variety of unstructured data, ensuring seamless data management capabilities.
• Mail Client Integration: Seamlessly incorporate email functionality into your application, allowing you to send notifications, verification emails, and other important messages to your users. This feature enables you to interact with popular email services and APIs for efficient communication with your audience.
• Authentication: Basic authentication is included which supports both normal login mechanism and google login mechanism.
• Error Handling: Implements error handling to provide a better user experience.
• Logging: Configured logging to monitor your application effectively.
• Testing: Includes testing setup and example test cases.
• Middleware Support: Easily integrate and customize middleware to enhance your application's functionality.
• Background Job Support: Background jobs are tasks that are processed asynchronously, typically for long-running or resource-intensive operations. In this context, it mentions the use of the gokraft/work library, which is a Go library for managing background jobs.

Getting Started

1. Clone the Repository and Install Required Libraries:

   git clone https://github.com/Shrijeeth/Golang-Fiber-App-Template.git
   cd Golang-Fiber-App-Template

2. Change Project Name:

   In go.mod file replace module name to name of your project. Then run the following command:

   make build

3. Environment Variables:

   Create a .env file in the root directory and add the necessary environment variables. You can use the provided .env.example as a starting point.

4. Database Setup:

   If you are using a database, set up the database connection in environment variables. Below are the currently supported SQL databases:

   • Postgresql
   • MySql

5. Cache Database Setup:

   If you are using a cache database like redis, set up the database connection in environment variables. Below are the currently supported Cache databases:

   • Redis

6. Cloud Object Storage Setup:

   If you are using a cloud object storage, set up the connection in environment variables. Below are the currently supported Cloud Object Storage platforms:

   • AWS S3
   • GCS

7. Email Client Setup:

   If you are using a email client, set up the connection in environment variables as mentioned. Below are the currently supported Email Service Providers:

   • Custom SMTP Provider along with Template Engine
   • Mailer Send

8. Application Linter:

   Run the following command to run the linter

   make lint
   

9. Application Unit testing:

   Run the following command to run the test suites for your application. Test related files will be stored under coverage folder

   make test
   

   To run tests along with coverage report run the following command

   make test.report
   

10. Run the Application:

    Run the following command to start the server

    make run
    

11. Access the Application:

    Your application should now be running locally at specified address in environment variable

Configuration

All application configuration should be in the .env file. Customize it to suit your project's needs. Use .env.example file as a starting point.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Fiber (https://gofiber.io): A fast, Express.js-like web framework for Golang.
• GORM (https://gorm.io): The fantastic ORM library for Golang.
• GolangCi-Lint (https://github.com/golangci/golangci-lint): golangci-lint is a fast Go linters runner.
• fiber-go-template (https://github.com/create-go-app/fiber-go-template): An amazing repository for fiber-go-template which served us a great inspiration to improve it additional functionalities.
• GoCraft Work (https://github.com/gocraft/work): An excellent repository for processing background jobs in Go