Skip to main content

Getting Started

The Resource Plugin simplifies the development of new resources and their CRUD operations. It provides a suite of generators to streamline your development process.

Installation​

Get started by adding the Resource Plugin to your project:

yarn add @softkit/resource-plugin

Generators Available​

The Resource Plugin comes with various generators:

  • app: Generates a new app for a resource.
  • boilerplate: Creates a basic structure for a new project, setting up essential configurations.
  • controller: Produces a new controller for a resource.
  • http-client: Creates a new HTTP client for an app.
  • i18n: Adds support for internationalization, including translation files and configuration.
  • lib: Generates a new library for a resource with optional i18n and config.
  • repository: Creates a new repository, typically used to manage database interactions for a specific entity or model.
  • resource: Creates a new resource with CRUD operations.
  • service: Generates a new service for a resource.

Next Steps​

  • To learn how to effectively utilize these generators in your project, proceed to the Usage documentation. This section provides comprehensive guidance on using each generator for creating applications, controllers, services, and more, helping you to fully leverage the capabilities of the Resource Plugin.
Last updated on by Y Dev