Build yourself a simple CRM from scratch in PHP and MySQL
Customer Relationship Management (CRM) is a system that manages customer interactions and data throughout the customer life-cycle between the customer and the company across different channels. In this tutorial, we are going to build a custom CRM in PHP, which a sales team can use to track customers through the entire sales cycle.
We’ll be creating a simple CRM system for salespeople to:
- Access their tasks
- View their leads
- Create new tasks for each lead
- Create new opportunity
- Close a sale
Sales managers will be able to:
- Manage all customers
- Manage sales team
- View current sales activities
Building Blocks of a CRM
Here is a list of the essential components of the CRM:
- Leads: initial contacts
- Accounts: Information about the companies you do business with
- Contact: Information about the people you know and work with. Usually, one account has many contacts
- Opportunities: Qualified leads
- Activities: Tasks, meetings, phone calls, emails and any other activities that allow you to interact with customers
- Sales: Your sales team
- Dashboard: CRM dashboards are much more than just eye candy. They should deliver key information at a glance and provide links to drill down for more details.
- Login: Salespeople and managers have different roles in the system. Managers have access to reports and sales pipeline information.
- PHP 5.3+,
- MySQL or MariaDB
Create CRM Database
We will start by creating our custom CRM database. The main tables we will be using are:
- contact — contains basic customer data
- notes — holds information collection from Contact by sales people.
- users — information about sales people
The Contact table contains basic customer information including names, company addresses, project information, and so forth.
The Notes table stores all sales activity information such as meetings and phone calls.
The Users table holds login information about users of the system such as usernames and passwords. Users can also have roles, such as Sales or Manager.
All other tables are lookup tables to join to the three main relational database tables.
- contact_status — contains contact status such as Lead and Opportunity. Each indicates a different stage in a typical sales cycle
- task_status — the task status can be either Pending or Completed
- user_status — a sale person can be Active or Inactive
- todo_type — a type of task either Task or Meeting
- todo_desc — description of a task such as Follow Up Email, Phone Call, and Conference etc.
- roles — a user can be either a Sales Rep or a Manager
Complete Database Schema Diagram
A database schema is the structure that represents the logical view such as tables, views, or primary and foreign keys of the entire database. A database schema includes entities and the relationship among them.
It is a good practice to have one primary key for each table in a relational database. A primary key is a unique identifier for each record. It can be the social security number (SSN), vehicle identification number (VIN), or auto-increment number. This is a unique number that is generated when a new record is inserted into a table.
Below is the database diagram of our simple CRM. The key symbol in each table represents the table primary key. The magnifying glass indicates foreign key linking another table in the database. Sometimes we call it the “lookup” table.
Once you have an understanding of the database table structure, find the “install.sql” script in the
db folder and use a MySQL tool such as MySQL Workbench or Sequel Pro to run the SQL script. It should create a new relational database named
custom_crm and its database tables.
A Side Note on ZenBase
The CRM application is also one of the many application templates readily available at ZenBase (built on the top of phpGrid) for anyone — with or without coding skills — to use and customize for their own needs.
Our CRM contains many datagrids. The datagrid is a spreadsheet-like data table that displays rows and columns representing records and fields from the database table. The datagrid gives the end-user ability to read and write to database tables on a webpage. We can use a datagrid tool from phpGrid. We use a tool instead of building them from scratch because developing the datagrid is usually tedious and error-prone. The datagrid library will handle all internal database CRUD (Create, Remove, Update, and Delete) operations for us with better and faster results with little code. To install phpGrid, follow these steps:
- Unzip the phpGrid download file.
- Upload the phpGrid folder to the
- Complete the installation by configuring the
Before we begin coding, we must specify the database information in
conf.php, the phpGrid configuration file. Here is an example of database connection settings:
- PHPGRID_DB_HOSTNAME — web server IP or host name
- PHPGRID_DB_USERNAME — database user name
- PHPGRID_DB_PASSWORD — database password
- PHPGRID_DB_NAME — database name of our CRM
- PHPGRID_DB_TYPE — type of database
- PHPGRID_DB_CHARSET — always ‘utf8’ in MySQL
To learn more about configuring phpGrid, check out phpGrid complete installation guide.
Before we can start building our first page of the CRM, it is a good practice to make the reusable page items such as header and footer.
The page will comprise of a header, menu, body and footer. We will start by creating a reusable page template.
This is a basic HTML5 template header. It includes a link to a custom stylesheet that will be created in a later step.
Notice the usage of
$_GET['currentPage']. Each page will set a value which will highlight the name of the current page on the top menu bar.
Include the following code in style.css for menu styling (minified). It will transform the above, unordered list into a menu.
Simple closing body and html tags.
Complete Page Template
This is the complete page template. The main content will go after
CRM Main Pages
Are you still with me? Good! We can now finally develop the first page in our CRM.
Our CRM for the sales team members has four pages:
Each page indicates a different stage in a typical sales cycle.
Sale People Page Design Mockup
Here’s our CRM design mockup for the sales people.
When a sales team member logged in, the first page he sees is a list of current tasks.
As you may recall, our Notes table holds all the sales activity information. We can create a datagrid and populate it from the Notes table using phpGrid.
The Tasks page main content is a datagrid. The following two lines will give us a list of tasks of the current sales person.
- The first line creates a phpGrid object by passing the SELECT SQL statement, its primary key —
ID, and then the name of the database table -
- The second and the final line calls display() function to render the datagrid on the screen. Check out the basic datagrid demo for more detail.
The leads page contains list of current leads that the sales person is responsible for. Each Lead can have one or many Notes. We will use the phpGrid master-detail feature for that.
We also need to use set_query_filter() to display only the leads,
Status = 1, and only for the current sales person.
Contact status table
A Lead becomes an Opportunity once it is qualified. The Opportunities page is similar to the Leads page. The only difference is the filtered status code in set_query_filter is
Status = 2.
Customers/Won has the
Status = 3. Similar to Leads and Opportunities, Customers/Won can also have Notes.
That’s all there is to it for sales people in our simple CRM.
The sales manager will have access to all records in the sales pipeline as well as the ability to manage sales team and customer data.
We will have a single web page with tabbed menu similar to the phpGrid tabbed grid demo.
Manager Dashboard Design Mockup
My Sales Reps
Each tab represents a table in the CRM database.
$_GET['gn'] will store the table name. It dynamically generates the datagrid based on table name passed.
It’s very easy to integrate jQueryUI Tabs with phpGrid. Please refer to the phpGrid Tabbed Grid demo for more information.
My Sales Rep Page
Since a sales manager needs to quickly find out whom a sale person is working with, we added a detail grid
$sdg populated from contact table and link with the master grid.
sales_rep is the connecting key in
contact table to the
id that is the foreign key in
users table. Remember the
users stores all of our sales people information.
CRM — Sales Screen
CRM — Manager Screen
Need to Write Even Less Code?
If you are new to programming and are not yet comfortable with coding, you may want to check out ZenBase that is built on the top of the phpGrid. The CRM is but one of the many application templates readily available at ZenBase for anyone — with or without coding skills — to use and customize for their own needs.