@react-pakistan/react-icon-collection

📌 React Pakistan 🔥🔥🔥

React Pakistan is an OpenSource & Free Software (FOSS) platform, creating React software solutions for the global community. ⭐⭐⭐

📌 React Icon Collection ✌

A generic, Icons library for React web apps, following modern approach by building your project's UI in isolation using state of the art Storybook along with React.

📌 Table of Contents 🚀

• Demo ✨
• Technology Stack ✨
• Installation ✨
• Usage ✨
• Styles ✨
• Tested ✨
• Contributors ✨
• Other Libraries from ReactPakistan ✨
• Support ✨
• Contact ✨
• Buy Me Coffee ✨

📌 Demo 🚀

Checkout React Icon Collection

📌 Technology Stack 🚀

• React ✨
• Storybook ✨
• TypeScript ✨
• JavaScript ✨
• Styled Components ✨
• Jest ✨
• Eslint ✨

📌 Installation 🚀

• Clone the repo
• Cd into the project folder
• Figure out which package manager you have on your system, then run following commands for their specific use cases.

  // to install dependencies
  yarn
  // to start local dev server
  yarn start
  // to run all tests locally
  yarn test

OR

  // to install dependencies
  npm install
  // to start local dev server
  npm start
  // to run all tests locally
  npm test

📌 Usage 🚀

Add React Icon Collection to your project.

  yarn add @react-pakistan/react-icon-collection

OR

  npm install @react-pakistan/react-icon-collection

Add React Icon Collection base theme to your project.

  yarn add @react-pakistan/util-functions

OR

  npm install @react-pakistan/util-functions

Refer to React Pakistan Docs for detail usage docs.

📌 Styles 🚀

Styled Components are employed to maintain and update theme for this project. Please consider adding Styled Component Provider wrapper to the entry point of your application, following is the sample code. You could either use the default theme as shown below or wire your custom theme object instead.

  import { ThemeProvider } from 'styled-components';
  import { theme } from '@react-pakistan/util-functions';

  <ThemeProvider theme={theme}>
    <App />
  </ThemeProvider>

📌 Tested 🚀

Since we wrote a script that generates all the icons on the fly, we don't feel the need to test all 1000's of React SVG components.

Should you like this project and would like to see more coming in future, please consider giving a ⭐ on Github project repo.

📌 Contributors 🚀

Thanks goes to these wonderful people (emoji key):

Contributors	GitHub	Emoji
	Taimoor Khan	🎨🤔🚧📆👀⚠️

📌 Other Libraries from ReactPakistan 🚀

📌 Support 🚀

If you need any help or have any question, please feel free to join ReactPakistan community at React Pakistan Slack.

📌 Contact 🚀

I can be reachable via Taimoor Web or else should you wish to send over an expression of your interest to contribute towards ReactPakistan, please shoot an email.

📌 Buy me Coffee 🚀