https://github.com/darkroomengineering/bibliotheca

library template
https://github.com/darkroomengineering/bibliotheca

boilerplate bundle library react template

Last synced: 3 months ago
JSON representation

library template

• Host: GitHub
• URL: https://github.com/darkroomengineering/bibliotheca
• Owner: darkroomengineering
• Created: 2022-08-24T17:36:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-07T16:56:47.000Z (over 1 year ago)
• Last Synced: 2024-05-06T19:29:44.636Z (9 months ago)
• Topics: boilerplate, bundle, library, react, template
• Language: JavaScript
• Homepage:
• Size: 423 KB
• Stars: 21
• Watchers: 3
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Bibliotheca](https://assets.studiofreight.com/bibliotheca/header.png)](https://github.com/studio-freight/bibliotheca)

## Introduction

Bibliotheca is our starting point to create libraries.




## Composition

This template kit is composed of:

- [Size Limit](https://github.com/ai/size-limit/)

- [Github Actions](https://github.com/features/actions)

- [Microbundle](https://github.com/developit/microbundle)

- [Typescript](https://github.com/microsoft/TypeScript) (tsc)

- [ESLint](https://github.com/eslint/eslint)

- [Prettier](https://github.com/prettier/prettier)

- [Vite](https://github.com/vitejs/vite) for dev purposes




## Folder Structure

- **/bundled:** Generated by `microbundle` after running `build:bundled` script. Includes all external dependencies.

- **/dist:** Generated by `microbundle` after running `build:dist` script.

  - **/dist/types** Generated by `tsc` after running `build:types` script.

- **/docs:** Used by `vite` through `dev` script to serve the documentation.

- **/docs/App.jsx:** here's where you can test your library.

- **/src:** Your library's raw code.




## Bibliotheca in use

- [@studio-freight/lenis](https://github.com/studio-freight/lenis) Tiny, Performant, Vanilla JS, Smooth Scroll library.

- [@studio-freight/tempus](https://github.com/studio-freight/tempus) One rAF to rule them all.

- [@studio-freight/hamo](https://github.com/studio-freight/hamo) Collection of React hooks.




## Authors

This toolkit is curated and maintained by the Studio Freight Darkroom team:

- Clement Roche ([@clementroche\_](https://twitter.com/clementroche_)) – [Studio Freight](https://studiofreight.com)

- Guido Fier ([@uido15](https://twitter.com/uido15)) – [Studio Freight](https://studiofreight.com)

- Leandro Soengas ([@lsoengas](https://twitter.com/lsoengas)) - [Studio Freight](https://studiofreight.com)

- Franco Arza ([@arzafran](https://twitter.com/arzafran)) - [Studio Freight](https://studiofreight.com)




## License

[The MIT License.](https://opensource.org/licenses/MIT)