Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/react-pakistan/react-icon-collection
React Icon Collection built upon React StoryBook
https://github.com/react-pakistan/react-icon-collection
Last synced: about 2 months ago
JSON representation
React Icon Collection built upon React StoryBook
- Host: GitHub
- URL: https://github.com/react-pakistan/react-icon-collection
- Owner: react-pakistan
- License: mit
- Created: 2019-08-09T17:56:32.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-19T05:24:56.000Z (over 1 year ago)
- Last Synced: 2024-10-29T02:48:28.706Z (2 months ago)
- Language: TypeScript
- Homepage: https://react-pakistan.github.io/react-icon-collection/
- Size: 19.6 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 📌 React Pakistan 🔥🔥🔥
React Pakistan is an OpenSource & Free Software (FOSS) platform, creating React software solutions for the global community. ⭐⭐⭐
[](https://github.com/react-pakistan/react-native-boilerplate/blob/master/LICENSE)
[](https://github.com/taimoormk)
[](https://github.com/react-pakistan/react-native-boilerplate)
[](https://github.com/react-pakistan/react-native-boilerplate)
[](https://GitHub.com/Taimoormk/StrapDown.js/graphs/commit-activity)
[](http://shields.io/)
[](https://GitHub.com/Taimoormk/ama)
[](https://github.com/ryo-ma/github-profile-trophy)
[](https://github.com/DenverCoder1/github-readme-streak-stats)
[](https://stars.medv.io/react-pakistan/react-native-icon-collection)
[](https://saythanks.io/to/Taimoormk)
## 📌 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](#-demo-) ✨
- [Technology Stack](#-technology-stack-) ✨
- [Installation](#-installation-) ✨
- [Usage](#-usage-) ✨
- [Styles](#-styles-) ✨
- [Tested](#-tested-) ✨
- [Contributors](#-contributors–) ✨
- [Other Libraries from ReactPakistan](#-other-libraries-from-reactpakistan-) ✨
- [Support](#-support-) ✨
- [Contact](#-contact-) ✨
- [Buy Me Coffee](#-buy-me-coffee-) ✨
### 📌 Demo 🚀
Checkout [React Icon Collection](https://react-pakistan.github.io/react-icon-collection)
### 📌 Technology Stack 🚀
- [React](https://reactjs.org/) ✨
- [Storybook](https://storybook.js.org/) ✨
- [TypeScript](https://www.typescriptlang.org/) ✨
- [JavaScript](https://javascript.info/) ✨
- [Styled Components](https://styled-components.com/) ✨
- [Jest](https://jestjs.io/) ✨
- [Eslint](https://eslint.org/) ✨
### 📌 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.
```console
// to install dependencies
yarn
// to start local dev server
yarn start
// to run all tests locally
yarn test
```
OR
```console
// 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.
```console
yarn add @react-pakistan/react-icon-collection
```
OR
```console
npm install @react-pakistan/react-icon-collection
```
Add React Icon Collection base theme to your project.
```console
yarn add @react-pakistan/util-functions
```
OR
```console
npm install @react-pakistan/util-functions
```
Refer to [React Pakistan Docs](https://react-pakistan.github.io/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.
```javascript
import { ThemeProvider } from 'styled-components';
import { theme } from '@react-pakistan/util-functions';
```
### 📌 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](https://allcontributors.org/docs/en/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](reactpakistan.slack.com).
### 📌 Contact 🚀
I can be reachable via [Taimoor Web](https://taimoor.io) or else should you wish to send over an expression of your interest to contribute towards ReactPakistan, please shoot an [email](mailto:[email protected]).
### 📌 Buy me Coffee 🚀
