Skip to content

prasad-bigdp/risingui-react

Repository files navigation

RisingUI

License npm version PRs Welcome

A modern React UI component library built with Vite and TypeScript.

✨ Features

  • 30+ customizable components
  • Built with accessibility in mind
  • Theme support with CSS variables
  • TypeScript support
  • Zero dependencies (except React)

🚀 Installation

npm install @prasad584/risingui
# or
yarn add @prasad584/risingui

🔧 Usage
jsx
import { Button, Card } from '@prasad584/risingui';

function App() {
  return (
    <Card>
      <Button variant="primary">Click me</Button>
    </Card>
  );
}
🤝 Contributing
We welcome contributions from everyone! Here's how you can help:

🛠️ Development Setup
Fork the repository

Clone your fork:

bash
Copy
git clone https://github.com/your-username/risingui.git
cd risingui
Install dependencies:

bash
Copy
npm install
# or
yarn install
Start development server:

bash
Copy
npm run dev
📝 Making Contributions
Create a new branch:

bash
Copy
git checkout -b feat/your-feature-name
# or
git checkout -b fix/issue-number
Make your changes following our:

Component Architecture Guidelines

Coding Standards

Test your changes:

bash
Copy
npm run test
npm run storybook # for visual testing
Commit your changes using Conventional Commits:

bash
Copy
git commit -m "feat(Button): add new size prop"
Push your changes:

bash
Copy
git push origin your-branch-name
Open a Pull Request to the main branch

🐛 Reporting Issues
Found a bug? Please open an issue with:

A clear title

Steps to reproduce

Expected vs actual behavior

Screenshots (if applicable)

Browser/OS version

🆕 Feature Requests
Have an idea? Create an issue with:

The problem you're solving

Your proposed solution

Any design references

🏷️ Branch Naming Convention
feat/: New features

fix/: Bug fixes

docs/: Documentation changes

chore/: Maintenance tasks

test/: Test-related changes

✅ Pull Request Checklist
Before submitting a PR:

Tests pass

Storybook examples updated

Documentation updated

TypeScript types added

Changeset added (npm run changeset)

No console warnings/errors

🏆 Your First Contribution
New to open source? Check out our Good First Issues.

📜 Code of Conduct
Please read our Code of Conduct before contributing.

📄 License
MIT © risingui-react

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors