Shelf-nu / shelf.nu

shelf is open source Asset Management Infrastructure for absolutely everyone.
https://shelf.nu
GNU Affero General Public License v3.0
1.78k stars 158 forks source link

Feature: 1068 Add a custom asset ID field #1078

Closed Teraskull closed 1 month ago

Teraskull commented 3 months ago

Hi! This is my attempt at being useful.

First of all, thank you for this amazing software. The best UI among all existing inventory management systems.

Full disclosure: I am a backend dev and have little experience in frontend. This is the first time I'm touching Remix and React.

I do not expect this PR to be merged, this is only to show the general UX of the custom Asset ID feature.

This is a rough naive working PoC for #1068 that adds an optional and unique propertyId field to the Asset table.

This PR misses a lot of implementation details, types, and does not account for a lot of places where the code should be updated.

Notes:

Known Issues:

image

Screenshots of the feature:

On the list of assets:

image

Creating/editing an asset:

image

On the asset page:

image

Overall, this does not look like a big feature to implement, I'm just unfamiliar with the codebase and the general flow.

Thanks!

carlosvirreira commented 3 months ago

Amazing @Teraskull we are super grateful that you took the time to submit a POC we have a scheduled discussion for it tomorrow on our Discord to provide some more info from our end.

You rock! Thank you!

Teraskull commented 3 months ago

Thanks a lot! I appreciate it @carlosvirreira

Would be super great if the QR Code block on the asset page gets hidden if an alternative ID is set, since the original ID will not be used for stickers anyways.

Also would be nice if when Geocode or Maptiler API keys are not set, hide the UI elements related to them too. Currently, the "Waiting for first QR code scan" block shows even without an API key.

DonKoko commented 3 months ago

@carlosvirreira Something we should already prepare is an article on our knowledge base on how the propertyId works and how users can use the custom url to redirect to an asset. I think a lot of users would love this feature. Once we have a link for this article, even if its not published yet, we can add it to the sub title of the field label.

carlosvirreira commented 3 months ago

@carlosvirreira Something we should already prepare is an article on our knowledge base on how the propertyId works and how users can use the custom url to redirect to an asset. I think a lot of users would love this feature. Once we have a link for this article, even if its not published yet, we can add it to the sub title of the field label.

We absolutely 100% will add to marketing site. I will pre-make the page and send the url here.

carlosvirreira commented 2 months ago

@carlosvirreira Something we should already prepare is an article on our knowledge base on how the propertyId works and how users can use the custom url to redirect to an asset. I think a lot of users would love this feature. Once we have a link for this article, even if its not published yet, we can add it to the sub title of the field label.

Here it is : https://www.shelf.nu/knowledge-base/understanding-and-using-custom-property-ids-in-shelf

Let me know if amendments need be made to the kb article

DonKoko commented 1 month ago

Closing due to inactivity. Feel free to re-open the PR when you want to resume this.