H0llyW00dzZ/templui
H0llyW00dzZ/templui
1
0
Fork 0
mirror of https://github.com/axzilla/templui.git synced 2025-02-06 10:44:17 +00:00
Code

chore: update readme, add CONTRIBUTING.md and LICENSE files

Browse Source
This commit is contained in:
“axzilla” 2024-10-05 18:31:56 +02:00
parent 8204928955
commit 488ec871bb
3 changed files with 114 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,65 @@
# Contributing to Goilerplate
First off, thank you for considering contributing to Goilerplate! We're excited to have you join our community.
## Our Vision and Your Contributions
Goilerplate is an open-source project that aims to provide value to the Go community. We want to be transparent about our long-term vision:
1. We may explore opportunities to monetize aspects of Goilerplate or offer premium services related to it in the future.
2. All contributions to this repository are subject to the MIT License, which allows for commercial use.
3. By contributing to Goilerplate, you agree that your contributions may be used in both open-source and potential future commercial aspects of the project.
4. We value every contribution and will always strive to maintain a strong, open-source core that benefits the entire community.
We believe this approach allows us to sustainably develop and maintain Goilerplate while keeping it open and accessible to all. If you have any questions or concerns about this, please reach out to us before contributing.
## How Can I Contribute?
### Reporting Bugs
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps.
### Suggesting Enhancements
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Explain why this enhancement would be useful to most Goilerplate users.
### Pull Requests
- Fill in the required template
- Do not include issue numbers in the PR title
- Follow the [Go style guide](https://golang.org/doc/effective_go.html)
- End all files with a newline
- Avoid platform-dependent code
## Style Guides
### Git Commit Messages
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
### Go Style Guide
Follow the official Go style guide and common practices in the Go community.
## Additional Notes
### Issue and Pull Request Labels
This section lists the labels we use to help us track and manage issues and pull requests.
- `bug` - Issues for bugs in the code
- `enhancement` - Issues for new features or improvements
- `documentation` - Issues related to documentation
- `good first issue` - Good for newcomers
## Recognition
We're committed to giving proper credit and recognition to all contributors. Your contributions, whether they're improvements to documentation, bug fixes, or new features, are invaluable to the growth and success of Goilerplate.
Thank you for contributing to Goilerplate and helping make it a great tool for the Go community!

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Axel Adrian
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

37
README.md
View File

@ -6,28 +6,47 @@ Modern UI Components for Go & Templ
## About
Goilerplate is a comprehensive UI component library designed specifically for Go developers using Templ. It provides a set of pre-built, customizable components that seamlessly integrate with Go backends and Templ templating, allowing for rapid development of modern, interactive web applications.
Goilerplate is a growing library of modern UI components designed specifically for Go and Templ. It aims to bridge the gap between Go's server-side efficiency and modern, interactive front-end experiences. Whether you're building a small website or a large web application, Goilerplate provides the tools you need to create sleek, responsive interfaces with ease.
## Features
- **Go-native Implementation**: Optimized for Go developers and seamlessly integrates with Go backends.
- **Go-native Implementation**: Optimized for Go developers, seamlessly integrating with Go backends.
- **Templ-first Design**: Leverages the full power of Templ for type-safe, high-performance templating.
- **Server-Side Rendering (SSR) Focus**: Excellent performance and SEO benefits out of the box.
- Alpine.js Support: For enhanced client-side interactivity when needed.
- **Alpine.js Integration**: Enhanced client-side interactivity when needed.
- **Tailwind CSS Styling**: Modern, utility-first styling that's highly customizable.
- **Accessible Components**: Built with accessibility in mind, following WCAG guidelines.
- **TypeSafe**: Utilizing Go's type system for robust, error-resistant development.
## README TODO
## Current Status
- [] Contributing
- [] License
- [] Support
- Actively growing component library
- Regular updates and bug fixes
- Continuous development based on community feedback
- Check our [Components page](https://goilerplate.com/docs/components) for the latest list of available components
## README APP
## Getting Started
- [] Add active classes for menu links
Visit our website at [https://goilerplate.com](https://goilerplate.com) to get started with Goilerplate. You'll find documentation, examples, and guides to help you integrate Goilerplate into your Go projects.
## Contributing
We welcome contributions from the community! Whether it's adding new components, improving existing ones, or enhancing documentation, your input is valuable. Please check our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get involved.
## Feedback
Your feedback is crucial in shaping the future of Goilerplate. If you have suggestions, feature requests, or encounter any issues, please open an issue on our GitHub repository or reach out to us through our website.
## License
Goilerplate is open-source software licensed under the [MIT license](LICENSE).
## Support
For support, questions, or discussions, please [open an issue](https://github.com/axzilla/goilerplate/issues) on our GitHub repository.
---
Built with ❤️ by the Go community, for the Go community.
[![Product Hunt](https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=494295&theme=light)](https://www.producthunt.com/posts/goilerplate-1?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-goilerplate-1)