[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url] [![install size](https://packagephobia.com/badge?p=posy-fnb-core)](https://packagephobia.com/result?p=posy-fnb-core)
Logo

by

Logo

Posy Fnb Design System

An awesome design system of posy fnb project by PVG
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments
## About The Project There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. Here's why: - Your time should be focused on creating something amazing. A project that solves a problem and helps others - You shouldn't be doing the same tasks over and over like creating a README from scratch - You should implement DRY principles to the rest of your life :smile: Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template! Use the `BLANK_README.md` to get started.

(back to top)

### Built With This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. - [![React][react.js]][react-url] - [![Typescript][typescript]][typescript-url] - [![TailwindCSS][tailwindcss]][tailwindcss-url] - [![Eslint][eslint]][eslint-url] - [![Prettier][prettier]][prettier-url] - [![Vercel][vercel]][vercel-url] - [Storybook][storybook-url] - [Husky][husky-url]

(back to top)

## Installation How to run a project, please follow the instructions below. ```bash npm install --save posy-fnb-core ``` or if you are using pnpm : ```bash pnpm add posy-fnb-core ```

(back to top)

## Usage How to add a packages into your project, please follow the instructions below. 1. import component ```bash import { Button } from 'posy-fnb-core' function App() { return ; } ``` 2. import styles ```bash import 'posy-fnb-core/dist/index.css' ``` 3. import preset (optional) ```bash const preset = require('posy-fnb-core/dist/preset.cjs') // add this line /** @type {import('tailwindcss').Config} */ module.exports = { content: [ './index.html', './src/**/*.{js,ts,jsx,tsx}', ], presets: [ preset ], theme: { extend: {}, }, plugins: [], } ```

(back to top)

## Roadmap - [x] Slicing components - [x] Add documentation using `storybook` - [x] Automate deploy using `vercel` - [ ] add unit testing components - [ ] Automate deploy storybook using `vercel` See the [open issues](https://git.infra.pvg.im/pvp-front-end/posy-fnb-core/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request

(back to top)

## License Distributed under the MIT License. See `LICENSE.txt` for more information.

(back to top)

## Contact Muammar Zaidan - [@zaidanammar](https://instagram.com/zaidan.ammar) - zaidanammar23@gmail.com Project Link: [posy-fnb-core](https://git.infra.pvg.im/pvp-front-end/posy-fnb-core)

(back to top)

## Acknowledgments Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off! - [Choose an Open Source License](https://choosealicense.com) - [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) - [Img Shields](https://shields.io) - [React Icons](https://react-icons.github.io/react-icons/search)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/zaidanammar/pintu?style=for-the-badge [contributors-url]: https://git.infra.pvg.im/pvp-front-end/posy-fnb-core/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/zaidanammar/pintu.svg?style=for-the-badge [forks-url]: https://git.infra.pvg.im/pvp-front-end/posy-fnb-core/network/members [stars-shield]: https://img.shields.io/github/stars/zaidanammar/pintu.svg?style=for-the-badge [stars-url]: https://git.infra.pvg.im/pvp-front-end/posy-fnb-core/stargazers [issues-shield]: https://img.shields.io/github/issues/zaidanammar/pintu.svg?style=for-the-badge [issues-url]: https://git.infra.pvg.im/pvp-front-end/posy-fnb-core/issues [license-shield]: https://img.shields.io/github/license/zaidanammar/pintu.svg?style=for-the-badge [license-url]: https://git.infra.pvg.im/pvp-front-end/posy-fnb-core/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://www.linkedin.com/in/muammar-zaidan/ [product-screenshot]: public/screenshot.png [lighthouse-screenshot]: public/lighthouse-score.png [react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB [react-url]: https://reactjs.org/ [typescript]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white [typescript-url]: https://www.typescriptlang.org/ [tailwindcss]: https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white [tailwindcss-url]: https://tailwindcss.com/ [eslint]: https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white [eslint-url]: https://eslint.org/ [prettier]: https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E [prettier-url]: https://prettier.io/ [vercel]: https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white [vercel-url]: https://vercel.com/ [react-query-url]: https://tanstack.com/query/v4 [husky-url]: https://typicode.github.io/husky/#/ [storybook-url]: https://storybook.js.org/