This project is a customer management system for a fictional business that sanitizes dustbins.
The program is responsible for managing customers details such as personal, contact and sanitizing details. Comments may be added for customers for administration use. Additionally, payment-related features can be used such as viewing the customers' current balance, payments made by the customer, and generated invoices for the customer. Customer accounts may also be deactivated or activated.
The payment section allows for administration to record payments made by customers. The payments page handles duplicate payments, balance updating, payment reversal, and other validation.
The invoice section allows for administration to generate invoices for customers and holds many searching and filtering features to quickly find the customer or group of customers the user is looking for. Invoices may be generated in batch and also allows the user to tweak certain dates on the invoice such as issue, fee, and brought-forward dates. Lastly, invoices for customers may be downloaded in batch for selected months.
The settings page allows administration staff to change or set certain features such as adding or removing bank details to display on customer invoices.
The project makes use of programming languages such as HTML5, CSS3, JavaScript, NodeJS and PHP. Additionally Bootstrap is used for styling.
See below instructions to quickly set up and install the project. The project makes use of all frameworks below.
- Ensure you have Composer installed.
- Navigate to the project directory:
cd cms. - Install PHP dependencies:
composer install.
- Ensure you have Node.js installed.
- Navigate to the project directory:
cd cms. - Install Node.js dependencies:
npm install.
- Bootstrap can be added to your project in several ways:
-Using npm:
bash npm install bootstrap-Using yarn:bash yarn add bootstrap
The database file may be found here. The database is already filled with data that readers may use for testing.
You will find a folder in the repository labelled config. It is important that you place this folder in the previous directory of the repository. The project has been set up this way as it is good security practice.
The db_conn.php file holds the database connection. See the installation regarding database set up. Ensure that the db_conn.php file holds the correct details to successfully connect to your database.
The keys.php file holds additional keys used in the site. The $secretLoginToken is used as the login token when accessing the token and you may set this to whatever you like.
The $recaptchaKey should be the secret key for your Google reCaptcha. See here how to setup your Google reCaptcha for the site. Please ensure to use reCaptcha v2 – "I am not a Robot" Checkbox. Note: Unfortunately as of the current version there is no work around to the Google reCaptcha and I apologise for the inconvenience this may cause in testing the project.
Lastly, in addition to providing your secret key for Google reCaptcha, ensure to provide your public key here in the data-sitekey attribute.
This section goes through notable features of the site.
The site makes use of a login key for administrators to be able to access customer data and perform tasks. If the administrator's session has expired they will be redirected to the login screen seen below. Additionally to prevent cyber attacks such as DDoS a Google reCaptcha is also implemented into the login page.
The search feature is used on multiple pages since customer databases can easily grow to large numbers making it cumbersome to find the customer you are looking for. For this reason, the default search feature allows the user to provide a search term as well as choose a search field, for example, account number, surname, and street name. This search feature is further built apon on the invoice page which you may view here
Customer details are subject to change, thus, the site provides a quick and easy way to edit customer data. Validation such as length, email validation, and format and always considered.
If customers decide to discontinue with the business, their accounts are not closed as they may have outstanding balances. For this reason, customer accounts are set as active or inactive.
In many cases administrators would add or edit comments as well as multiple contacts for individual customers.
Payments can be recorded on the payments page for each customer. Addition to recording payments, the customer's balance will also be updated and recorded in the balances table with all the neccessary details of the transaction.
It is possible that human error can occur while recording payments. For this reason, payment reversal has been implemented. When a payment is reversed, the customer's payment record will be removed along with the balance recorded inserted into the balances table when the payment was recorded.
In addition to erroneous input when recording payments, a payment may be mistakingley inserted again. Each payment is checked before inserting it into the database to ensure there is not an existing payment with the same date, amount, and type.
Invoice generation using the CMS allows you to select which customers you would like to generate invoices for as well as set certain dates for the invoices. From the search section the administrator can select which customers they would like to generate invoices for and they will be displayed in the "Selected Customers" sections. One all invoice details are filled in, the administrator may generate the invoices all at once as seen below. A progress bar along with updates will be displayed at the bottom. All invoices are stored as .xlsx files.
Note: The site is designed so that invoices are not accessable from the htdocs folder, instead, along with the config folder, all invoices are stored in the parent directory in the invoices folder. While invoices are easily accessible from the site, authorised users may access the invoices from the mentioned directory.
The search feature is expanded on in the invoices page for users to easily find groups of customers. It is important to mention that only active customers are displayed by default on the invoice page, however, this can be overriden using the filters. Administrators may choose to do the following:
- Display all active customers (defaut).
- Display all active customers with pending invoices (this refers to all customers that do not have an invoice for the current month yet).
- Display all inactive customers.
- Display all inactive customers with pending invoices. From the group of customers returned from the above filters, administrators may still add a search term and search field.
With the risk of human error, it is possible that duplicate invoices may be generated. For this reason, duplication checking is run before generating the invoices. The administrator has the option to cancel the action, overwrite the current invoices, or remove those selected customers from the list and generate invoices for the remaining.
It is possible to download invoices from a customer's profile, however, this will quickly become tedious as the number of customers grow. On the invoices page administrators are able to download invoices in batch where it will be downloaded to their local device as a .zip file. Administrators can download invoices in batch from a certain month and year as seen below.
Administrators may set default bank accounts to avoid having to manually edit each customer's details. When changing the default bank account the administrator has additional options:
- All future customers will be linked with the selected bank account.
- All customers linked with the current default bank account will be linked to the new default bank account.
- All customers will be linked to the new default bank account.
Contributions from the community are most welcomed! Whether it's reporting a bug, submitting a feature request, or improving the documentation, your help is appreciated. To contribute to this project, please follow these guidelines:
If you encounter any issues or find a bug, please check the existing issues to see if it has already been reported. If not, please open a new issue, including the following details:
- A clear and descriptive title.
- A detailed description of the issue, including steps to reproduce.
- Screenshots or code snippets, if applicable.
- Information about your environment (operating system, browser, etc.).
You are welcome to suggest new features or improvements. Before submitting a feature request, please:
- Check the existing feature requests to avoid duplicates.
- Provide a clear and detailed description of the proposed feature.
- Discuss the feature with the community to gather feedback.
Pull requests for bug fixes, new features, and improvements are welcomed as well. To submit a pull request, follow these steps:
- Fork the repository and create a new branch for your contribution.
- Write clear and comprehensive commit messages.
- Test your changes thoroughly.
- Submit a pull request, referencing the relevant issue (if applicable).
- Be prepared to address feedback and iterate on your changes.
By contributing to this project, you agree that your contributions will be licensed under the project's license. Thank you for contributing to the project! 🚀
This project makes use of the MIT License
For any questions and support, contact me at [email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent