Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 1.61 KB

README.md

File metadata and controls

69 lines (43 loc) · 1.61 KB

templUI Quickstart

Get started with templUI, an enterprise-ready UI component library for Go and templ. This template provides a pre-configured setup for building professional web applications with templUI components.

Installation

For installation instructions, visit our documentation.

Setup

  1. Clone the Repository

    git clone https://github.com/axzilla/templui-quickstart.git
cd templui-quickstart

  2. Install Dependencies

    go mod tidy

  3. Configure Tailwind Since we're using templUI as a package, you need to configure Tailwind to process its components:

    a. Get your Go path:

    go env GOPATH

    b. Add the path to your assets/css/input.css content array:

    @source "${GOPATH}/pkg/mod/github.com/axzilla/templui@*/**/*.{go,templ}";

Development

Start the development server with hot reload:

make dev

Your application will be running at http://localhost:7331

Deployment

This template includes a production-ready Dockerfile for easy deployment:

# Build the image
docker build -t templui-app .

# Run the container
docker run -p 8090:8090 templui-app

Your application will be available at http://localhost:8090

Contributing

Issues and pull requests are welcome! Please read our contributing guidelines before submitting a pull request.

License

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