Welcome to PatternBook!
PatternBook is an Open Source lightweight zero-config component mapping tool designed to run in the CLI and generate documentation in less than 30 seconds.
We currently support the following:
- Node.js 18+
- A React + TypeScript project
Initial install:
Running the Tool
- run
npm i patternbook-cli - run
npx patternbook serve - run
npx patternbook scan
PatternBook is an Open Source product that happily welcomes contributions. We invite anyone interested to contribute. Please consider the following instructions when contributing. There are planned features listed below and... of course you can suggest features too.
- We reccommend forking a copy and creating a new branch.
- This branch should be clearly labeled with your name and it should indicate the feature or fix
- Clone our Repo.
- Create a new branch.
- Do your thing!
- Run our tests.
- Let us know by submitting a PR merging your branch into dev. (We recieve automatic updates for PR requests, but if you like you can also contact us if you like.)
| Feature | Status |
|---|---|
| Zero Config | |
| NPM package for CLI | ✅ |
| Supports TypeScript components | ✅ |
| Creates Manifest | ✅ |
| Creates Dependecy Graph | ✅ |
| Scanner | ✅ |
| Parser | |
| Sandbox | |
| Token Bridge | |
| Success Metric | |
| Responsive UI | ⏳ |
| PostCSS config (ex. Tailwind) | ⏳ |
| CSS imports via ESM (including CSS modules) | ⏳ |
| Shared state between any component shortcode | 🙏🏻 |
- ✅ = Ready to use
- ⏳ = In progress
- 🙏🏻 = Looking for contributors
Dylan Pangilinan - front end software engineer
https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white "github")
