Bosch Inventory Management System

A simple application to view and manage inventory
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

A part time side project built in python by using PyQt5 framework to render spotless UI and SQLite3 for robust database management

(back to top)

Built With

(back to top)

Getting Started

To install this application, you will need python installed on your system and be present in your PATH variable.

(Optional) Python Package Mangement System like Anaconda or Poetry.

Prerequisites

Verify whether Python is installed in your system or not.

• Shell

  $ python --version

Installation

Follow the steps to set up the project.

1. Clone the repo

   git clone https://github.com/KXN2004/Bosch-Inventory.git
   cd Bosch-Inventory

2. Install Project Dependencies (Preferably using conda)

   conda install --name ENVIRONMENT_NAME --channel conda-forge python=3.12 pyqt sqlalchemy

(back to top)

Usage

Set up the project by following the installation procedure mentioned above

Or run a executable on your system by downloading it from the Releases

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

LinkedIn - @Kevin Nadar - [email protected]

Project Link: https://github.com/KXN2004/Bosch-Inventory

(back to top)