https://github.com/vinniciusgomes/react-library-architecture

🛠 Archref for React Library with TypeScript
https://github.com/vinniciusgomes/react-library-architecture

jest react react-library rollup stitches storybook

Last synced: 3 months ago
JSON representation

🛠 Archref for React Library with TypeScript

• Host: GitHub
• URL: https://github.com/vinniciusgomes/react-library-architecture
• Owner: vinniciusgomes
• License: mit
• Created: 2022-03-29T19:18:49.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-29T21:07:10.000Z (almost 3 years ago)
• Last Synced: 2024-04-17T01:06:17.227Z (9 months ago)
• Topics: jest, react, react-library, rollup, stitches, storybook
• Language: JavaScript
• Homepage: https://vinniciusgomes.dev
• Size: 4.3 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


  

  






  

  

  

    

  

  

    

  

  

   

    

  



## Principles

- Dependencies

  - All build-time dependencies must be defined in `peerDependencies`

    - It also necessaries add do `devDependencies`

  - `dependencies` it just added if the library has an specific dependencies

- Testing library

  - Use demo application for validate your library

  - Use `npm link` to validate integration resources [link](https://docs.npmjs.com/cli/link.html)

---

## Building with [Rollup](https://rollupjs.org/)

- Apart from compile TS to JS, it is currently prepared to handle fonts, images _(svg,png,jpg,jpeg,gif)_ and json

  - fonts are copied and referenced

  - JSONs are embeded in the bundle

  - Images are encoded to base64 and are bundled or chunked

---

### Before releasing new library

- Do not forget to delete MyComponent

  - It is only a sample

- Edit Readme, filling template below with valid information

- Edit Changelog to reflect new library

- For new components, use the template below to describe it

---

# Components

## MyComponent

- Props

```tsx

interface MyComponentProps {

  children: ReactChild

}

```

- Usage

```tsx

import { MyComponent } from 'react-library-architecture';

valid-text

```