Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 2.89 KB

README.md

File metadata and controls

87 lines (62 loc) · 2.89 KB
Raw

Flutter CRM Dashboard

GitHub stars GitHub issues GitHub license Flutter

Overview

Futter CRM Dashboard is a cross-platform Customer Relationship Management application developed using Flutter. It aims to provide a seamless experience across Web, Windows, macOS, Android, and iOS. Currently in the development phase, this project offers a free version that serves as a dashboard and template for users to utilize and extend.

Features

  • Cross-Platform Compatibility: A single codebase for all major platforms.
  • Responsive Design: Adapts to various screen sizes and orientations.
  • Free to Use: The dashboard is available for free to encourage community contributions and use.
  • Customizable Template: Easily adapt the template to fit specific business needs.
  • **Bloc / Provider

Branches

  • crm-provider: used default provider state management
  • main: used flutter_bloc state management

Screenshots

screenshot1.png screenshot2.png

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Flutter SDK
  • An IDE (e.g., Visual Studio Code, Android Studio)
  • Emulators/Simulators for testing (optional)

Installation

  1. Clone the repository: 
    git clone https://github.com/spiky-star/FlareLine-CRM.git
  2. Navigate to the project directory: 
    cd FlareLine-CRM
  3. Get the dependencies: 
    flutter pub get

Running the Application

  • For Web: 
    flutter run -d chrome
  • For Desktop (Windows, macOS): 
    flutter run -d windows
flutter run -d macos
  • For Mobile (Android, iOS): 
    flutter run -d android
flutter run -d ios

Contributing

We welcome contributions to the project! Please follow the guidelines below:

  1. Fork the project repository.
  2. Create a new branch for your feature (git checkout -b feature/YourFeatureBranchName).
  3. Commit your changes (git commit -m 'Add your feature description here').
  4. Push to the branch (git push origin feature/YourFeatureBranchName).
  5. Create a new Pull Request.

License

This project is is 100% free and open-source; feel free to use it with your personal and commercial projects

Acknowledgments

  • Flutter community for the great framework.
  • Contributors to the project.