@react-pakistan/react-commons-collection
    TypeScript icon, indicating that this package has built-in type declarations

    6.10.4 • Public • Published

    📌 React Pakistan 🔥🔥🔥

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

    License Followers Forks Stars

    React Commons Collection Badge Branches React Commons Collection Badge Functions React Commons Collection Badge Lines React Commons Collection Badge Statements

    Maintenance Maintaner Website shields.io Ask Me Anything !

    Ryo-ma's github trophy

    DenverCoder1's github streak

    Sparkline

    saythanks

    📌 React Commons Collection

    A generic, Commons 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 🚀

    Checkout React Commons Collection

    📌 Technology Stack 🚀

    📌 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 Commons Collection to your project.

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

    OR

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

    Add React Commons 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. See Typography & Colors being used in the theme object.

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

    📌 Tested 🚀

    We aim to achieve 100% coverage and we shall...

    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 🚀

    Buy Me A Coffee

    Install

    npm i @react-pakistan/react-commons-collection

    DownloadsWeekly Downloads

    255

    Version

    6.10.4

    License

    MIT

    Unpacked Size

    238 kB

    Total Files

    306

    Last publish

    Collaborators

    • taimoormk