https://github.com/ahmedalsanadi/ahmeds-react-lib
https://github.com/ahmedalsanadi/ahmeds-react-lib
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ahmedalsanadi/ahmeds-react-lib
- Owner: ahmedalsanadi
- Created: 2025-02-20T14:35:29.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-02-20T15:25:51.000Z (2 months ago)
- Last Synced: 2025-02-20T16:32:23.104Z (2 months ago)
- Language: TypeScript
- Size: 251 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ahmed's React Component Library
## 🚀 Overview
`ahmeds-react-lib` is a modern, lightweight React component library designed to provide reusable and customizable UI components for your web applications.
## ✨ Features
- 🧩 Modular and Reusable Components
- 🔧 Easy Integration
- 💅 Styled with Modern Design Principles
- 🛡️ TypeScript Support
- 🧪 Thoroughly Tested
## 📦 Installation
Install the library using npm:
```bash
npm install ahmeds-react-lib
```
## 🔍 Available Components
Currently available components:
- `Page`
- `Button` (coming soon)
## 💻 Usage
### Page Component
```jsx
import { Page } from 'ahmeds-react-lib';
function MyComponent() {
return (
{/* Your page content */}
);
}
```
## 🛠️ Development
### Prerequisites
- Node.js (>=20.17.0)
- npm (>=10.0.0)
### Repository
Find the project on GitHub: [ahmeds-react-lib](https://github.com/ahmedalsanadi/ahmeds-react-lib)
### Available Scripts
- `npm run build`: Build the library
- `npm test`: Run tests
- `npm run lint`: Lint the code
- `npm run storybook`: Start Storybook development server
## 🧪 Testing
The library uses Jest and React Testing Library for comprehensive testing.
Run tests with:
```bash
npm test
```
## 🔬 Storybook
Explore components interactively:
```bash
npm run storybook
```
## 🚢 Continuous Integration
Powered by CircleCI, ensuring:
- Linting
- Testing
- Building
- Automated Releases
## 📝 License
MIT License
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## 📞 Contact
Ahmed Al-Sanadi
- GitHub: [@ahmedalsanadi](https://github.com/ahmedalsanadi)