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:

npm install ahmeds-react-lib

🔍 Available Components

Currently available components:

• Page
• Button (coming soon)

💻 Usage

Page Component

import { Page } from 'ahmeds-react-lib';

function MyComponent() {
  return (
    <Page>
      {/* Your page content */}
    </Page>
  );
}

🛠️ Development

Prerequisites

• Node.js (>=20.17.0)
• npm (>=10.0.0)

Repository

Find the project on GitHub: 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:

npm test

🔬 Storybook

Explore components interactively:

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