genericsuite 0.5.1

GenericSuite Mobile Flutter package.

GenericSuite for Mobile (Flutter/Dart version)

Welcome to GenericSuite, a comprehensive software solution designed to help you enhance your productivity and streamline your workflows.

GenericSuite Mobile brings the GenericSuite JSON-driven CRUD pattern to Flutter apps: define your entities in JSON config files, mount the CrudEditor widget — no per-entity Dart code needed for standard CRUD, and take advantage of the customizable login interface, menu builder, and a suite of tools to kickstart your Flutter/Dart Mobile App development process.

Features

• Customizable CRUD editor: core CRUD (Create, Read, Update, Delete) code that can be parametrized and extended by JSON configuration files. There's no need to rewrite code for each table editor.
• Customizable menu: menu and endpoints can be parametrized and extended by JSON configuration files in the backend side. The API will supply the menu estructure and security check based on the user's security group, and GenericSuite will draw the menu and available options.
• Customizable Login Screen: Easily adapt the login screen to match your brand identity with the App logo.
• Development and Production Scripts: Quick commands to start development or build your application for QA, staging or production environments on popular cloud providers.
• Customizable Widgets: A set of widgets that can be parametrized and extended by JSON configuration files.
• Flutter/Dart: The GenericSuite is built with Flutter/Dart, making it compatible with both Android and iOS.

The perfect companion for this mobile solution is the backend version of The GenericSuite.

Getting started

Pre-requisites

• Flutter SDK
• Android Studio (to manage Android SDK, emulators, etc.)
• Xcode (to manage iOS SDK, emulators, etc.)
• GenericSuite mobile package
• GenericSuite backend package
• Git
• Make (Mac) | Linux has Make installed by default | Make (Windows)

Don't have a Flutter project?

Create a new Flutter project using the flutter create command:

flutter create exampleapp

Installation

• Add the genericsuite package:

flutter pub add genericsuite

Or manually:

1. Open the pubspec.yaml file and add the GenericSuite to the dependencies: section:

  genericsuite:
    git:
      url: https://github.com/tomkat-cr/genericsuite-mobile
      ref: main  # or develop
      path: genericsuite_flutter

2. Install the dependencies.

flutter pub get

Usage

• Check the GenericSuite Mobile Development Guide for more information about how to create mobiles apps using GenericSuite.

Usage examples

• Check the Usage Examples for code examples and app building instructions.

Configuration

• Check the App Creation and Configuration Guide for more information about how to create the JSON configuration files.

• Check the Backend Guide for more information about how to create the API.

Additional information

Package Documentation and Starter Template

• GenericSuite Mobile Development Guide

• Library README: genericsuite_flutter

• Starter template: flutter_project_template

GenericSuite Documentation

• https://genericsuite.carlosjramirez.com
• Mirror: https://genericsuite.readthedocs.io

How to contribute to the package

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Create a pull request to the main repository.

How to file issues

1. Go to the GenericSuite GitHub repository.
2. Click on the "Issues" tab.
3. Click on the "New Issue" button.
4. Fill out the issue template with the necessary information.
5. Submit the issue.

What response you can expect from the package authors

1. We will respond to your issue as soon as possible.
2. If you have a bug report, we will try to fix it as soon as possible.
3. If you have a feature request, we will try to implement it as soon as possible.
4. If you have a question, we will try to answer it as soon as possible.

License

GenericSuite is open-sourced software licensed under the MIT license.

Credits

This project is developed and maintained by Carlos J. Ramirez. For more information or to contribute to the GenericSuite project, visit GenericSuite on GitHub.

Happy Coding!