Jaishree2310 / GlassyUI-Components

GlassyUI: Elegant Glassmorphism Components for Modern UIs
https://glassyui.vercel.app
60 stars 113 forks source link
gssoc-ext hacktoberfest

🌟 GlassyUI-Components

Live Demo: GlassyUI

Welcome to GlassyUI-Components! This open-source library features stunning React components designed with a captivating glassmorphism effect, perfect for giving your web applications a modern and sleek design.

Project Structure ✨

Check the project structure here Project Structure

πŸ“š Table of Contents

Project Overview

This open-source library features stunning React components designed with a captivating glassmorphism effect, perfect for giving your web applications a modern and sleek design.

This project is now OFFICIALLY accepted for

GSSoC 2024 Extd
Hacktober fest 2024


🌟 Stars 🍴 Forks πŸ› Issues πŸ”” Open PRs πŸ”• Closed PRs
Stars Forks Issues Open Pull Requests Closed Pull Requests

✨ Features

πŸ› οΈ Components

πŸ› οΈ Tech Stack

πŸ–₯️ Website Preview

Home Page Components Button

πŸš€ Getting Started

Prerequisites

Make sure you have Node.js and npm installed on your machine.

Installation with docker

  1. clone the repository:
git clone https://github.com/Jaishree2310/GlassyUI-Components.git
cd GlassyUI-Components
  1. Run Docker compose File:
docker compose up

Installation without docker

  1. Clone the Repository:
git clone https://github.com/Jaishree2310/GlassyUI-Components.git
cd GlassyUI-Components
  1. Install Dependencies:
npm install
  1. Start the Development Server:
npm start
  1. Open your browser and go to http://localhost:3000 to see the components in action.

πŸ“œ Changelog

All notable changes to this project will be documented in this file.

[Unreleased]

[1.0.0] - 2024-10-15


πŸ“ Usage

Import the desired component into your React project and use it as follows:

import { GlassyButton } from 'glassyui';

function App() {
  return (
    <div className='App'>
      <GlassyButton>Click Me</GlassyButton>
    </div>
  );
}

πŸš€ Future Enhancements / Roadmap

Feature/Improvement Description
🎨 Theme Customization Allow users to customize the glassmorphism effect with different colors and opacities.
β™Ώ Accessibility Improvements Ensure all components are fully accessible to users with disabilities.
βž• Additional Components Introduce new components such as dropdowns, tooltips, and tabs.
⚑ Performance Optimization Optimize the library for faster load times and better performance.
πŸ“š Documentation Expansion Provide comprehensive guides and examples for each component to facilitate easier usage and contribution.

🀝 Contributing

We welcome contributions to make this library even better! Here are a few steps to help you get started:

  1. Fork the Repository: Create your own copy of the repository.

  2. Create a Branch: For your feature or bug fix.

git checkout -b my-feature-branch
  1. Make Changes: Implement your feature or fix.

  2. Commit Your Changes:

git commit -m "Add my feature"
  1. Push to the Branch:
git push origin my-feature-branch
  1. Open a Pull Request: Submit your changes for review.

Contribution Rule

-Please ask for issue assignment before raising any PR.

-If more than 1 week issue is not resolved then it will be assigned to someone else.

Code of conduct:

-Important Rule for Creating component to follow the order of component.

  1. Basic Usage
  2. Props 3.Customizable component
  3. Theme (of your new component)
  4. Example
  5. Copy code

-for eg: Button component,Progress Bar components

Our Contributors

| Contributor | Contributor | Contributor | Contributor | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Jaishree2310

[Jaishree2310](https://github.com/Jaishree2310) πŸ‘©β€πŸ’»

| Sawan-Kushwah

[Sawan-Kushwah](https://github.com/Sawan-Kushwah) πŸ‘¨β€πŸ’»

| Gauravtb2253

[Gauravtb2253](https://github.com/Gauravtb2253) πŸ‘¨β€πŸ’»

| Alolika

[Alolika](https://github.com/alo7lika) πŸ‘©β€πŸ’»

| | Hritika

[Hritika](https://github.com/hritika2409) πŸ‘©β€πŸ’»

| Aditya Innovates

[Aditya Innovates](https://github.com/AdityaInnovates) πŸ‘¨β€πŸ’»

| Neeru

[Neeru](https://github.com/neeru24) πŸ‘©β€πŸ’»

| Haseeb Zaki

[Haseeb Zaki](https://github.com/haseebzaki-07) πŸ‘¨β€πŸ’»

| | Gurliv

[Gurliv](https://github.com/gurliv21) πŸ‘©β€πŸ’»

| Abhishek Hegde

[Abhishek Hegde](https://github.com/abhishekHegde2000) πŸ‘¨β€πŸ’»

| Naz

[Naz](https://github.com/NazTM) πŸ‘©β€πŸ’»

| Kode Craze

[Kode Craze](https://github.com/kodeCraze) πŸ‘¨β€πŸ’»

| | Masabin

[Masabin](https://github.com/masabinhok) πŸ‘©β€πŸ’»

| Ameer Jafar

[Ameer Jafar](https://github.com/Ameerjafar) πŸ‘¨β€πŸ’»

| Devx Mani

[Devx Mani](https://github.com/devxMani) πŸ‘¨β€πŸ’»

| Ashish

[Ashish](https://github.com/ashish-um) πŸ‘¨β€πŸ’»

| | Va Manjain

[Va Manjain](https://github.com/VAmanjain) πŸ‘©β€πŸ’»

| Lakshmi Rajvagu

[Lakshmi Rajvagu](https://github.com/lakshmirajvagu) πŸ‘©β€πŸ’»

| Knight Hinata

[Knight Hinata](https://github.com/knighthinata) πŸ‘¨β€πŸ’»

| ADeshmukh

[ADeshmukh](https://github.com/ADeshmukh80) πŸ‘¨β€πŸ’»

|

🌟 So many talented contributors! πŸŽ‰ Want to meet them all? Click here to discover the amazing team! πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

patch-1

Stargazers ❀️

[![Stargazers repo roster for @Jaishree2310/GlassyUI-Components](https://reporoster.com/stars/dark/Jaishree2310/GlassyUI-Components)](https://github.com/Jaishree2310/GlassyUI-Components/stargazers)

Forkers ❀️

Forkers repo roster for @Jaishree2310/GlassyUI-Components


main

License

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


πŸ’— Stargazers

[![Stargazers repo roster for @Jaishree2310/GlassyUI-Components](https://reporoster.com/stars/Jaishree2310/GlassyUI-Components)](https://github.com/Jaishree2310/GlassyUI-Components/stargazers)

πŸ’— Forkers

Forkers repo roster for @Jaishree2310/GlassyUI-Components

-----------------------------------------------------

⭐ Give it a Star!

If you enjoy using GlassyUI-Components and find it helpful, please give it a star! Your support encourages further development and improvement.

🌐 Contact with Me

Email LinkedIn Twitter GitHub Instagram


Thank you for connecting with me! πŸ’¬