CRUD-O

A lightweight, 0-boilerplate and flexible CRUD framework built around Bloc and Flutter.

Getting Started

You will basically be writing four files foreach model you want to interact with from the backend:

• A Resource file
• A Repository file
• A Factory file
• A Serializer file

Resource

Resources are the core of the CRUD-O framework. You should create a resource foreach model you need to interact with from the backend.

Repository

A Repository is a class that extends the ResourceRepository. It is responsible for interacting with the backend. It's created with simplicity and readability in mind so the only thing you need to provide is the path to the endpoint you want to interact with, the standard methods to retrieve and send data to the backend are already implemented. You can extend the repository to add custom methods to interact with the backend.

Factory

A Factory is a class that extends the ResourceFactory. It is responsible for creating new instances of objects for these scenarios:

• createFromJson: When deserializing a model from a json object
• createFromJsonList: When deserializing a list of models from a json object

A special method createFromMap is present. This is used as a fallback for the other methods when they are not implemented. If your factories are all equal you can just override this method instead of all the others.

Note: If you don't provide a createFromMap and you don't implement the other methods, the factory will throw an error when trying to deserialize a model in the scenarios mentioned above.

Serializer

A Serializer is a class that extends the ResourceSerializer. It is basically the opposite of the Factory. It is responsible for serializing a model into a map object for these scenarios:

• serializeToJson: When serializing a model to a json object to send over the network
• serializeToView: When serializing a model to a key-value map to display in the view page

Components

With crud-o you will instantly get a set of pages ready to interact with your backend. This package will provide you: TODO: Add the components here

Auth

The auth mechanism is set up using the CrudoAuthWrapper widget. This widget will wrap your application and will provide the auth context to all the pages that need it. You can also provide a custom Future authCheck to check if the user is logged in or not, then you can pass the loggedIn and loggedOut widgets to show the user the login page or the main page.

The CrudoAuth will also provide a login and logout extension on the BuildContext so you can easily call these methods from anywhere in your app to login or logout the user.

Permissions

CRUD-O uses Image picker to pick images from the gallery or the camera. Make sure to add the necessary permissions to your AndroidManifest.xml and Info.plist files as described in the project's documentation.