Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme.md #196

Merged
merged 3 commits into from
Oct 20, 2024
Merged

update readme.md #196

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93af6e6
Update README.md
lakshmirajvagu Oct 16, 2024
9a0d4ec
Update README.md
lakshmirajvagu Oct 16, 2024
f47fc3c
Merge branch 'main' into updated
lakshmirajvagu Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@

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](#project-overview)
- [Features](#Features)
- [Components](#components)
- [Tech Stack](#tech-stack)
- [Website Preview](#WebsitePreview)
- [Prerequisites](#Prerequisites)
- [Installation with docker](#Installationwithdocker)
- [Installation without docker](#Installationwithoutdocker)
- [Changelog](#Changelog)
- [Usage](#Usage)
- [Future Enhancements / Roadmap](#future-enhancements--roadmap)
- [Contributing](#contributing)
- [Contribution Rule](#ContributionRule)
- [Code of Conduct](#code-of-conduct)
- [Our Contributors](#our-contributors)

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


<img src="https://raw.githubusercontent.com/alo7lika/GlassyUI-Components/refs/heads/main/Images/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="900">

### This project is now OFFICIALLY accepted for
Expand Down Expand Up @@ -41,6 +65,7 @@ Welcome to **GlassyUI-Components**! This open-source library features stunning R
</tbody>
</table>


## ✨ Features

- Glassmorphism-themed React components
Expand All @@ -57,6 +82,14 @@ Welcome to **GlassyUI-Components**! This open-source library features stunning R
- **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](https://github.com/user-attachments/assets/f6f73936-ca0d-4232-a646-67189f5aa901)
Expand Down Expand Up @@ -190,6 +223,11 @@ git push origin my-feature-branch

-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
Expand All @@ -202,6 +240,7 @@ git push origin my-feature-branch
-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! ⭐
Expand Down