Laragintempltail

Forkan-dev
4

go gin templ tailwind backend ready boilerplate like laravel

Go Gin Boilerplate with Laravel-Like Structure, Templ, Tailwind CSS, Preline UI and Air for Scalable Web Applications

A boilerplate for building modern backend applications using the Go Gin framework, integrated with TailwindCSS, Preline UI components, and live reloading with Air for rapid development.

Features

Lightweight and efficient backend powered by Gin.
UI styling with TailwindCSS and components from Preline.
Live reload during development using Air.
Well-organized project structure for scalability and maintainability.

Getting Started

Prerequisites

Ensure the following tools are installed on your system:

Go (1.19 or newer recommended)
Node.js (v16 or newer) with npm
Air for live reloading
TailwindCSS and Preline libraries (included in the setup steps)

Installation

Clone the Repository

git clone https://github.com/Forkan-dev/laragintempltail.git
cd laragintempltail

Set Up TailwindCSS

Navigate to the resources directory where TailwindCSS is configured.
```
cd resources
npm install
```
This will install all required dependencies for TailwindCSS, including Preline components.
Initialize Air

Ensure you have Air installed globally. If not, install it using the following command:
```
go install github.com/cosmtrek/air@latest
```
Once installed, return to the root directory of the project and run:
```
air init
```
This will create an .air.toml configuration file. The air configuration is already included in the repository, so you should not need to modify it.
Run the Application

Start the live reload server using Air:
```
air
```
Your application will be running at http://localhost:8080 by default.

Project Structure

├── main.go               # Entry point of the application
├── resources/            # Contains TailwindCSS configuration and assets
│   ├── tailwind.config.js  # TailwindCSS configuration file
│   ├── package.json        # NPM configuration file
│   └── ...                 # Other assets
├── views/            # HTML templ templates for the application
├── public/               # Static files (CSS, JS, images)
├── routes/               # Gin route definitions web
├── app/          # Handlers for routes, middleware etc
└── .air.toml             # Air configuration for live reloading

Development

TailwindCSS Customization

To customize the TailwindCSS configuration, modify the tailwind.config.js file located in the resources folder. After making changes, rebuild the CSS by running:

npm run build

Alternatively, use npm run watch for automatic rebuilds during development.

Live Reload with Air

Air watches your Go files and automatically reloads the server upon detecting changes. To use it:

Ensure main.go is correctly set up as the entry point.
Start the server with air from the root directory.

Deployment

Build the Application

Use the Go build command to create a production-ready binary:
```
go build -o app .
```
Static Assets

Ensure all TailwindCSS and static assets are built before deployment:
```
npm run build
```
Run the Application

Start the compiled binary:
```
./app
```

Contributing

Contributions are welcome! Please fork the repository, make changes, and submit a pull request for review.

License

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

Acknowledgments

Happy coding!

Top categories