https://github.com/mattpocock/xstate-catalogue

Professionally designed, interactive state machines
https://github.com/mattpocock/xstate-catalogue

state-machine typescript xstate

Last synced: 3 months ago
JSON representation

Professionally designed, interactive state machines

• Host: GitHub
• URL: https://github.com/mattpocock/xstate-catalogue
• Owner: mattpocock
• License: mit
• Archived: true
• Created: 2021-03-20T18:45:36.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-16T17:11:56.000Z (over 2 years ago)
• Last Synced: 2024-05-02T05:59:35.566Z (7 months ago)
• Topics: state-machine, typescript, xstate
• Language: TypeScript
• Homepage: https://xstate-catalogue.com
• Size: 353 KB
• Stars: 808
• Watchers: 13
• Forks: 62
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - xstate-catalogue

README

        
![XState Catalogue](./public/og-image.png)

[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)

# XState Catalogue

XState Catalogue is a collection of professionally designed state machines you can drop into your XState projects.

**We're accepting contributions!** We'd love to hear your ideas for new machines and ways to improve the catalogue.

Check out the [full site](https://xstate-catalogue.com) for the full browsing experience.

### Setting up the repo

1. Run `yarn install`

2. Run `yarn dev` to run it on localhost:3000

### Contributing a new machine

1. Run `yarn generate` to generate the boilerplate for a new machine.

2. Follow the instructions in the CLI.

3. Just like that, you can start editing the files and write a new machine.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Mark Chandler
💻

    
Matt Pocock
💻 🤔 💡 🎨

    
Henri Maurer
💻 🤔

    
Bernhard Mayr
💻 🤔

    
Damien Sedgwick
💻

    
Rubén Moya
💻

    
Nicolai Bjerre Pedersen
💻

  

  

    
Tim Deschryver
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!