Skip to main content

Intro

Rattus ORM is a versatile JavaScript/TypeScript package that offers an Object-Relational Mapping (ORM) like experience for JS/TS applications. It is developed based on the source code of "vuex-orm-next", ensuring compatibility with its API while broadening its applicability beyond specific state managers.

warning

Rattus ORM is currently in its 0.*.* stages. We welcome feedback and contributions to help improve and evolve the package.

Features

  • Flexible Integration: Designed to work with any front-end state management library, providing a versatile solution for state handling.
  • Source Code Foundation: Built upon the source code of "vuex-orm-next" – the next iteration of Vuex ORM.
  • Intuitive Syntax: Simplifies the handling of complex data structures in front-end applications with an ORM-like approach.
  • TypeScript Support: Offers full TypeScript support for type safety and an enhanced development experience.
  • Efficient Data Management: Optimized for front-end data operations, ensuring efficient and reactive state management.

Before start

If you're new or need help with the basics, check out the "vuex-orm-next" documentation. It's got everything you need to start - simple explanations and examples that show you how to use it. This guide is great for beginners and anyone who wants to learn more about how it works. It's easy to follow and will help you get the hang of things quickly.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct, and the process for submitting pull requests.

License

Rattus ORM is open-sourced software licensed under the MIT License.