partkeepr / partkeepr

Open Source Inventory Management

PartKeepr is an inventory management software, primarily designed for electronic components.

PartKeepr is written in PHP and using the Symfony2 framework.

Demo Sites

To test everything which has been written so far, there are two demo pages prepared.

The latest release from github is available at http://demo.partkeepr.org. The most up-to-date version of the GitHub master branch is published at https://demo-git.partkeepr.org. Both demo pages are built from the git sources and reset to a demo state once an hour.

Requirements

PartKeepr needs:

• PHP between 7.0 and 7.1 - migration to newer symfony is needed before we support current php 7.x
• A MySQL or PostgreSQL database

Installation

Please read our setup guide

Thanks

A very big "thank you" goes out to Georgyo of NYC resistor - although he claimed that he isn't creative, he invented the name "PartKeepr" which eventually became the project's name.

partkeepr's Issues

Create build target to remove debugging calls

Right now, the code hasn't got many debugging calls.

Debug code should remain in the master source to allow efficient development, but the end user shouldn't be affected by these calls, because they slow down operation.

For JavaScript debugging output, we use the console.log feature supported by Firefox+Firebug and Chrome/Chromium.

For PHP, we need to invent something like:

PartDB2::debug("message");

The phing build target should remove all those calls automatically when building a release version.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Data Migration from PartDB1

We need to migrate existing data from PartDB1. I don't know yet if we should migrate the data during the installation process, or if it should be done afterwards, but this needs to be done for V1.

Upload Window

We wish to display how many "MB" an user may upload as configured in PHP. Maybe we can also include a list of formats ImageMagick can eat.

User Groups

Users need to put into groups and groups can have permissions.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Item order "wishlist" per user

Users can create a wishlist of parts they want, so they can be ordered when refilling the stock.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

V2 Permissions

We wish to introduce a full fledged permission system.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Sortfunktion 4 parts by last new part / last add stock

Mail/Link buttons

Each link or email field should be replaced with nice special widgets.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

eastereggs

Part Search

An advanced part search needs to be implemented. In V1, we will only have a name search, but we also want parametric search and search for specific fields.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Part Detail Printing

We need to be able to print the part details including the parameters.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

create release target

The release target should:

• collect all files together
• create a minified version of all JS files

User Settings

We need to store some parameters per user - we need to build the API to store user settings and then decide which settings we wish to store.

Data Import

A user must be able to import existing data. Often people have their existing inventory in an excel spreadsheet.

PartKeepr must be able to import part data from CSV/Excel files. The easiest way to solve this is to specify an import format, so that users can re-format their existing data for importing.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Interface to external cash systems

Might be RZL-internal only

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Browser Compatibility Test

Before release, we need to test the software in those browsers:

• Mozilla Firefox 3
• Mozilla Firefox 4
• Google Chrome
• Safari
• Internet Explorer 6 (doesn't need to work, but if it does -great!)
• Internet Explorer 7
• Internet Explorer 8
• Internet Explorer 9
• Opera

We should also include the browsers and their status (i.e. software is working etc) into a document so users know which browsers are OK and which aren't.

Part Images and Files

We need to attach images and files to parts. This includes data sheets, images and so on.

Help System

Since we're using ExtJS as GUI, it should be medium-easy to implement a context-sensitive help. Help items could be managed in some wiki, and loaded into a frame on the client.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

i18n/l10n (Translation / Localization)

We want the system to speak your language. Technically, all JS code is wrapped by i18n() which does the translation later - we just need to implement it and create a gettext parser to eat JS files.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

V1 Permissions

For V1, we only have two permissions: User and Admin (and no access, of course).

Users and Admins are equal except that an admin may edit users, where users may not.

Information Gateway 2 Twitter / IRC ...

Generate a twitter / irc msg 4 new parts / new useres ...

More Stats

V3 bewegungen / zeit
V3 belegter plattenplatz für pdf / bilder
V3 server status?

Storage Location Value

Calculate+display the value of all items in a storage location

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

add .js files automatically to index.html

Modify the build script to add all js files in frontend/js/* to the index.html file. This is currently done manually.

Storage Location: Size and other parameters

Each storage location can have parameters like:

• Number of boxes
• Size

we need to implement that.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Generate part name from parameters

Each Part can have parameters (like: Capacity 10uF, max. voltage 30V). Now the PartDB should generate the name automatically from these parameters without the need to retype them as part name - in our example, the system should now generate "Electrolythic Capacitor 10uF 30V". If the parameters are updated for any reason, the name is also updated.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Stock Level less than Minimum Stock

The system needs to show all parts where their stock level is less than their minimum stock, so we can re-order the parts.

Deprecated / Until stock lasts

We need to mark an item as deprecated (if the manufacturer stopped doing that part) and until stock lasts for suppliers.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Storage Location Image

We wish to attach an image of the storage location

Show stock history

We need to be able to view a history who put in/put out how many parts.

General Stats

Straight from our requirements sheet:

lagerdauer
umschlagsdauer
lagernutzungsgrad

Those are all for V3, we need to discuss this.

Knowledge Base

I think this will end up in a wiki, but we had it on the plan for V3 so I'll create an issue for that.

Part parameters

We want parts to be parametrized. Each part can have as many parameters as the user wish to enter.

The parameter types are defined separately. It needs to be possible to create a parameter type "Resistance", which is of type "numeric", has the unit "Ohms". Si-Prefix conversion is applied automatically. To avoid that someone gets a list of all Si-Prefixes (Pico-Ohm is quite a bit wrong), it needs to be defined which Si-Prefixes apply to which units (or parameters?). Terafarad is unlikely, as well as Picoohm.

To make "near-value" matching easier, we need to store the value as "normalized" value - i.e. if the unit is Farad, we store 10pF as 10*(10^-12) in the database, if possible.

Use jslint to check javascript files

Data Export

This is a dummy bug to remember us to think about data export - what to export, in which formats etc.

If you have ideas or requests, put them here.

Internal Cart

Often, people need to put together a list of parts they need for a project. So they search each part, but then need to write it down.

Requirement is that people can add that one part to their internal shopping cart. Once they have everything they need, they can "checkout" (which means that the parts are booked into the system as removed) and print a list of all parts including their storage location.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Order List export

It would be nice if we can export the list of to-be-ordered parts to a supplier like Reichelt so people don't need to copy'n'paste all parts by hand.

Sortfunktion 4 Categorys

Label/Barcode/Inlay Printing

We wish to:

• Print labels or barcodes for storage locations
• Print inlays for different types of containers (e.g. H1 Boxes which are common in germany)

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Footprint or Part Type (SMD/PCB/Other)

Sometimes we have parts which sound like "cool, I can use that for my project" but then realize it's SMD-stuff. We need to attach some kind if information how the part can be used.

For example, there's SMD (which obviously can't be used without a PCB), there are breadboard compatible parts (2.54mm), and also parts which don't fit into 2.54mm (like ethernet jacks for PCB) and parts which can't be put onto PCBs at all (e.g. non-PCB transformers).

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

.rpm/.deb packages and .exe WAMP installer

To make it easier for users, we can provide "binary" packages. This is a low-priority issue which is scheduled for Version 3.0 or much later.

Ordering System

If parts are below the minimum stock level, we need to re-order them.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Logo

We don't have a nice logo yet.

Part value

We need to add a part value (just like in the original PartDB2).

We also need to show this value in the stats.

Footprint Image / Attachments

Each footprint needs to be able to get footprint images attached. Also more attachments, like footprint dxfs, are wanted.

Copy+Edit Part

Sometimes we have so many parts of one kind that we need two storage locations for it, or we simply have slightly the same part (e.g. CD4049UBE instead of CD4049UBF).

So we want a button which duplicates a part and opens the editing window.

I'd suggest we only add all data for a part into a new part window, so the user can cancel the edit without leaving trash in the database if the button was clicked by mistake.

Cloud

We want cloud, because we can ;) Discussion of what and how should be in this issue.

Toolkits to calculate resistor values etc

We want some widgets to display or calculate things like:

• Resistor color code to value and vice versa
• Help for capacitor codes (e.g. 53n10) or 331

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Find similar parts

Often, you need a part which you don't have - but you might have similar parts which you don't know about.

For example, you might need a 100kOhm resistor, but you don't have them anymore. The system should now search for all parts in a +-10% range so if you have 110kOhm resistors, they will be displayed.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Part reservation

If someone adds a part to their cart, the item should be marked as "blocked" or something to indicate that this part is reserved.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.