peachy-go/desktop/README.md

56 lines
1.8 KiB
Markdown
Raw Normal View History

2024-11-05 12:17:27 +00:00
# WailsV3 Project with HTMX and Templ
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
Welcome to the WailsV3 project template integrating HTMX and Templ, inspired by [this project](https://gitlab.isima.fr/rovandemer/astroproject). This template provides a starting point for building modern web applications with Go, leveraging the power of Wails, HTMX, and Templ.
## 🚀 Features
- **WailsV3**: A framework for building desktop applications using Go and web technologies.
- **HTMX**: A library that allows you to access AJAX, CSS Transitions, WebSockets, and Server-Sent Events directly in HTML.
- **Templ**: A Go template engine designed for simplicity and ease of use.
## 📋 Requirements
Before you begin, ensure you have the following installed:
- **WailsV3**: [Installation Guide](https://v3alpha.wails.io/getting-started/installation/)
- **Go**: [Download Go](https://go.dev/dl/)
## 📄 Documentation
- **Templ Documentation**: [templ.guide](https://templ.guide)
- **WailsV3 Documentation**: [v3alpha.wails.io](https://v3alpha.wails.io)
## ⚙️ Installation
1. **Clone the Repository**
```bash
git clone https://github.com/OnHenriGolera/Wails3-HTMX-Templ-Template
cd Wails3-HTMX-Templ-Template
```
2. **Install Dependencies and Build the Application**
```bash
wails3 build
```
3. **Run the Application**
```bash
wails3 dev
```
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 💡 Inspirations
- Inspired by the [Astroproject](https://gitlab.isima.fr/rovandemer/astroproject).
- Thanks to the developers of Wails, HTMX, and Templ for their amazing tools.
---
Feel free to enhance this template to suit your project's specific needs. Happy coding! 🎉
---