Skip to content

Santos-Enoque/flexilayout

Repository files navigation

FlexiLayout

style: very good analysis Powered by Mason License: MIT

FlexiLayout is an advanced Flutter package designed to empower developers to quickly assemble and deploy versatile, responsive user interfaces with ease. Tailored for both web and desktop applications, FlexiLayout offers an extensive range of customizable layouts and components, making it the ideal toolkit for creating intuitive and aesthetically pleasing UIs.

🚀 Key Features

  • 📐 Prebuilt Layout Templates: Speed up development with a variety of ready-to-use layouts, including adjustable pane designs and dashboard interfaces.
  • 📲 Responsive and Adaptive: Ensure your application looks great on any device, with components that automatically adjust to different screen sizes.
  • 🖱️ Drag-and-Drop and Resizable Panes: Create dynamic user experiences with adjustable and interactive layout elements.
  • 🔧 Modular and Customizable: Enjoy the freedom of customization with modular components that can be tailored to fit your specific design needs.
  • ⚙️ Easy Integration: Seamlessly integrate with existing Flutter projects, thanks to an intuitive and straightforward setup process.
  • 📚 Comprehensive Documentation: Get up to speed quickly with detailed documentation, including usage examples and configuration guides.
  • 🌐 Open Source and Community-Driven: Join a community of developers contributing to the evolution of FlexiLayout, ensuring it stays current with the latest trends and best practices in Flutter development.

Installation 💻

❗ In order to start using Flutter Admin Panel you must have the Flutter SDK installed on your machine.

Add flexilayout to your pubspec.yaml:

dependencies:
  flexilayout: 0.1.0-beta

Install it:

flutter packages get

📖 Example Usage

Here's a quick glimpse at how you can use FlexiLayout in your project:

import 'package:flexilayout/flexilayout.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // Add example code
  }
}

Continuous Integration 🤖

FlexiLayout comes with a built-in GitHub Actions workflow powered by Very Good Workflows but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the Very Good Workflows.


Running Tests 🧪

For first time users, install the very_good_cli:

dart pub global activate very_good_cli

To run all unit tests:

very_good test --coverage

To view the generated coverage report you can use lcov.

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html

💪 Contributing

Contributions to FlexiLayout are welcome! Whether it's submitting bug reports, feature requests, or contributing code, your involvement significantly enhances the quality and functionality of the package.

📜 License

FlexiLayout is available under the MIT license. See the LICENSE file for more info.