Mobile Spare Parts Management System (MSPMS)

👋 Introduction:

The Mobile Spare Parts Management System (MSPMS) is a versatile and robust desktop application tailored to streamline the management of spare parts inventory, user roles, and business transactions. Built with Python as the core programming language, SPMS integrates seamlessly with both local (SQLite) and online (MySQL) databases, ensuring flexibility and scalability for businesses of varying sizes. The system provides role-based access for administrators and sales personnel, making it a secure and efficient tool for day-to-day operations.

The application features advanced reporting capabilities, generating professional PDF reports using the wkhtmltopdf library. It also simplifies database management through tools like SQLite DB Browser for local database viewing and XAMPP phpMyAdmin for managing MySQL databases. With its modular design and interactive user interface, SPMS offers an intuitive and user-friendly experience for both technical and non-technical users.

📸 Screenshots:

Below are the following screenshots (SS) of the project:

🚀 Features:

The project have following features:

1. Database Management:

• Local database: SQLite for offline data storage.
• Online database: MySQL for remote and multi-user access.
• Use of SQLite DB Browser for viewing and managing SQLite databases.
• Integration with XAMPP phpMyAdmin for managing MySQL databases.

2. User Authentication and Authorization:

• Secure login and signup functionalities.
• Role-based access control (Admin and Salesman roles).
• Assign, manage, and modify user roles and permissions.

3. Inventory and Spare Parts Management:

• Add, edit, delete, and view spare parts records.
• Maintain accurate inventory levels.

4. Transaction Management:

• Record and update sales and purchase transactions.
• Track and view historical transaction logs.

5. Reporting and Documentation:

• Generate detailed PDF reports using wkhtmltopdf.
• Utilize pre-designed HTML templates for consistent and professional report formatting.

6. Interactive Dashboards:

• Admin Dashboard: Manage users, roles, permissions, and inventory.
• Salesman Dashboard: Manage sales-related activities and transactions.

7. Development Utilities:

• Batch file (run_app.bat) for quick setup and launch.
• Modular code structure for easy maintenance and scalability.

🔧 Technologies & Tools:

Following technologies and tools were used in this project:

1. Python: Backbone of the application for developing the user interface, logic, and database interactions.

2. wkhtmltopdf: Converts HTML templates into professional PDF reports.

3. SQLite DB Browser: A user-friendly tool for managing and viewing local SQLite databases.

4. XAMPP phpMyAdmin: A web-based tool for managing MySQL databases hosted locally or remotely.

🌐 Live Demo:

To get live demo, visit the below platform:

🛠️ Installation:

To download and install or customize follow below steps:

Step 1: Download the project

1. Clone the repository to download project.

Step 2: Create & Activate a Virtual Environment

1. Open your terminal or command prompt (CMD) in the project directory.
2. Run the following command to create a virtual environment: python -m venv venv
3. Activate this ceated virtual environment by following commnd in already opend CMD: venv\Scripts\activate

Step 3: Install Required Packages

1. Create or If Already Created Run, a requirements.txt file in the project's root directory with the following content (one package name per line):

   mysql-connector-python tk etc...

2. Run the following command to install these packages: pip install -r requirements.txt

Step 4 : Install all required dependecies

Enusre you must have install these Prerequisites dependencies/softwares to install & run the project successfully:

1. Install Python

1. Download and install Python from their original website: https://www.python.org/downloads/
2. Just Intall this software depedency in your pc any Local Disk you want. But recommended is use default path of Local Disk C.
3. Install it for all users and Tick the add pip library during install.
4. NOTE: Must Check the box 'add to path' during installaton.

2. Install PIP (Python Package Manager)

1. Ensure PIP is installed with Python for managing project dependencies.

3. Install wkhtmltopdf (makes html template to a pdf report files)

1. Download the wkhtmltopdf spftware from their original website: https://wkhtmltopdf.org/
2. Intall this software depedency in the folder 'dependency' of project folder like this: Mobile Spare Parts Management System MSPMS/dependency/wkhtmltopdf

📄 Usage

Follow below insructions to use & run the project:

Step 1: Create Databases

1. Run the database.py file to set up databases.
2. It will create a local SQLite database in the local_database folder.
3. It will also create a MySQL database in your localhost's phpMyAdmin.

Step 2: Insert Initial Data

1. (Optional but recommended for development and testing)
2. Add initial data to the databases as needed.

Step 3: Start the Application

1. Run the application using the main.py file by using CMD command: python main.py
2. Alternatively, you can Run the batch file: run_with_batch.bat
3. Recommended method is Point 2 to run application.

Step 4: Default Login Credentials (Initial Dummy Data)

1. Admin Username: admin Password: Admin@123

2. Salesman Username: salesman Password: Salesman@123

Note

1. Ensure Python and its libraries are correctly installed, as the application will not function otherwise.
2. Follow the setup steps precisely to avoid errors.

💬 Contact:

You can contact me using below methods:

1. Email - [email protected]
2. Linkedin - musmandeveloper
3. GitHub - musmandeveloper
4. Portfolio Website - musmandeveloper.vercel.app

👨‍💻 Contribution

We warmly welcome contributions to improve this project! If you discover any issues, have suggestions for enhancements, or would like to add new features, please follow the steps below to contribute:

Step 1. Fork the Repository

Click the "Fork" button at the top-right corner of this repository to create your own copy.

Step 2. Clone Your Fork

Clone your forked repository to your local machine using the following command: git clone https://github.com//.git

Step 3. Create a New Branch

Create a branch for your changes to keep the main branch clean and organized. Use below command: git checkout -b

Step 4. Make Your Changes

Improve the project by fixing bugs, adding new features, or refining the documentation.

Step 5. Test Your Changes

Ensure your changes work as expected and don’t break existing functionality.

Step 6. Commit Your Changes

Commit your changes with a descriptive message: **git commit -m "Descriptive message about the changes" **

Step 7. Push Your Changes

Push your changes to your forked repository: **git push origin **

Step 8. Submit a Pull Request (PR)

Go to the original repository on GitHub and click on the “Pull Requests” tab. Click “New Pull Request” and follow the instructions to submit your PR. Ensure you describe the changes you made and why they improve the project.

Guidelines to be must followed during contribution:

1. Follow the project’s coding style and conventions.
2. Keep your changes focused and avoid unrelated updates.
3. Include clear and concise documentation for any new features.
4. Be respectful and constructive when discussing issues or reviewing PRs.

Your contributions make this project better and more impactful. Thank you for taking the time to contribute! 🙌

📜 License:

This project is licensed under the MIT License. You are free to use, modify, and distribute the code as per the terms of the license.

What This Means for You

1. Free Use: You can use this project for personal or commercial purposes without restrictions.

2. Modification and Distribution: You are allowed to modify the code and distribute your versions, provided you include the original license.

3. Attribution: Kindly credit the original author by including a link to this repository or mentioning the project.

4. No Warranty: This software is provided "as is," without any warranty of any kind. Use it at your own risk.

Full License Text

The complete license details can be found in the LICENSE file in the root of this repository.

Contribution and Licensing

By contributing to this repository, you agree that your contributions will also be licensed under the MIT License.