Skip to content

kashif0313/crm

Repository files navigation

CRM System

This CRM (Customer Relationship Management) system, built with Laravel, empowers businesses of all sizes to manage and streamline their customer interactions. It offers a user-friendly interface and leverages the following technologies:
Laravel Livewire Alpine.js Tailwind CSS Chart.js

  • Laravel: A robust PHP framework providing a solid foundation for building web applications.
  • Livewire: A Laravel framework component facilitating interactive UIs without full page reloads.
  • Chart.js: A popular JavaScript library for creating various types of visual charts and graphs to present data effectively.
  • Alpine.js: A lightweight JavaScript framework enabling reactive and interactive UI elements without complex frameworks.
  • Tailwind CSS: A utility-first CSS framework providing a comprehensive set of pre-built classes for rapid UI development.

Table of Contents

  • Introduction: #introduction
  • Features: #features
  • Installation: #installation
  • Usage: #usage
  • Contributing: #contributing
  • License: #license

Introduction

The CRM System helps you:

  • Manage customer information, including adding, editing, and deleting customer records.
  • Track sales activities from leads and opportunities to closed deals.
  • Generate reports for comprehensive performance analysis based on sales metrics and customer interactions.
  • Securely control access and permissions through a user authentication system.

Features

  • Comprehensive Customer Management:

    • Create, edit, and delete detailed customer records.
    • Track interaction history for better understanding of customer behavior.
  • Secure User Authentication:

    • Manage user accounts with different roles and permissions.
    • Maintain user credentials securely using Laravel's authentication features.
    • Control access to specific functionalities based on user roles.

Desktop View

First Image Second Image First Image Second Image Second Image Second Image Second Image Second Image

Mobile View

First Image First Image First Image First Image First Image First Image First Image First Image

Installation

Prerequisites:

  • PHP 8.0+
  • Composer

Steps:

  1. Clone the repository:

    git clone https://github.com/kashif0313/crm.git
  2. Navigate to the project directory:

    cd crm
  3. Install dependencies:

    composer install
  4. Configure environment:

    • Copy .env.example to .env and update your database and other application settings.

    • Generate an application key:

      php artisan key:generate
  5. Run database migrations:

    php artisan migrate
  6. Start the development server:

    php artisan serve
  7. Access the application:

    Open http://localhost:8000 in your web browser.

Usage

Once installed, log in using the default credentials (modify these for production):

Explore the system and its features to manage your customer relationships effectively.

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Make your changes and commit them with clear, descriptive messages.
  4. Push your changes to your branch.
  5. Create a pull request.

Please refer to the contribution guidelines (https://docs.github.com/articles/setting-guidelines-for-repository-contributors) for more details.

License

This project is open-source and licensed under the MIT License (https://opensource.org/license/mit).

Additional Notes:

  • Feel free to modify or extend this README file as needed.
  • Provide clear explanations and examples for each technology used.
  • Consider including screenshots or a short demo video to showcase the system's functionality.
  • Address potential issues raised in the ratings and provide clear explanations for any choices made.
  • Maintain a friendly and welcoming tone for the contributing guidelines.