Skip to content

Latest commit

 

History

History
257 lines (176 loc) · 8.49 KB

README.md

File metadata and controls

257 lines (176 loc) · 8.49 KB
Raw

🌟 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.

📚 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

  • Glassmorphism-themed React components
  • Customizable styles with SCSS
  • Beginner-friendly and easy to contribute
  • Modular and reusable components

🛠️ Components

  • Buttons: Various button styles with glassmorphism effect.
  • ProgressBar: Animated progress bars with a glassy look.
  • Input Fields: Sleek input fields styled with glassmorphism.
  • Textareas: Stylish textareas with a glassy touch.
  • Modals: Elegant modals featuring the glassmorphism effect.
  • Navigation Bar: Modern navigation bars with a glassy theme.

🛠️ Tech Stack

  • React: JavaScript library for building user interfaces.
  • SCSS: A CSS preprocessor for more manageable styles.
  • Docker: For containerization and easy deployment.
  • Node.js: JavaScript runtime for server-side development.

🖥️ 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]

  • Added: A new button component with hover effects.
  • Changed: Updated SCSS styles for improved responsiveness.
  • Fixed: Resolved an issue with the modal not closing properly on mobile devices.

[1.0.0] - 2024-10-15

  • Added: Initial release of GlassyUI-Components.
    • Features glassmorphism-themed buttons, progress bars, input fields, text areas, modals, and navigation bars.
  • Improved: Documentation and examples for each component.
  • Fixed: Minor bugs in the button component.

📝 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:

  • This README structure includes all the sections you wanted.
  • Adjust the contributors section as needed based on your actual contributors.
  • Feel free to add or modify any content to better fit your project’s specific needs!

-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

  • We truly appreciate your incredible contributions to this project! Your dedication and hard work are vital to its continued growth and success. If you’ve found value in it, don’t forget to show your support by giving our repository a star! ⭐

⭐ 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.