Personal Electronics Parts Inventory

An awesome app to store your personal electronics parts and manage inventory with ease.

Table of Contents

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

About The Project

Am a mechatronics engineer by profession and i own a small electronics manufacturing lab. Finding an inventory app for my parts has been a long time problem.

There are many great Inventory apps available either open source or commercial; however, I didn't find one that really suited my needs so I created this custom one. The goal is to create an inventory app thats simple, customizable and easier for your awesome lab inventory -- I think this is it.

Here's why:

• A project that solves a problem and helps others
• Its simple and easily customizable to suit your needs.
• Its open source 😄

Of course, no one app will serve all and your needs may be different. So I'll be adding more features in the near future if time and resources allow. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

Enjoy.

(back to top)

Built With

This project is built with this great frameworks and libraries.

• Node Js
• Electron
• Semantic Ui
• Sqlite3
• Jquery
• Moment Js
• SweetAlert
• ...and many more.

(back to top)

Getting Started

Installation

Installations steps.

1. Download and install node Node Js
2. (optional) Download github desktop. It makes things easier especially if it's your first time using git
3. Clone the repo

   git clone https://github.com/muchirijohn/inventory
   cd inventory

4. Install NPM packages - Dependencies

   npm install

(back to top)

Running

Run this command from inside inventory

   npm run start

Building

This packs the app using electron packager Currently set to Win x64. Configure package.json to build for other platforms e.g Mac OS, Linux.
Run this command from inside inventory

   npm run pack:win

(back to top)

(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

@muchiri15john - [email protected]

https://github.com/muchirijohn/inventory

(back to top)

Acknowledgments

Inspiration, feedback, and testing:

• Mercy Ngoiri
• Evans Mwaura
• Karuri Gakure
• Mevolkan

(back to top)