search

hiukim / mind-ar-js

Web Augmented Reality. Image Tracking, Face Tracking. Tensorflow.js
MIT License
2.12k stars 391 forks source link

no NPM package is problematic #515

Open Johnrobmiller opened 2 months ago

Johnrobmiller commented 2 months ago

When I was reading the docs, (https://hiukim.github.io/mind-ar-js-doc/face-tracking-quick-start/webpage), I noticed that integration is done using HTML \<script> tags and that there is no NPM package.

The reason why I'm opening up an issue is because most web devs do not integrate using raw HTML \<script>. This makes integrating this repo very difficult. In most modern js frameworks, you can't (or it's difficult to) put things in the top level HTML that requires javascript interactivity like this. This is because js frameworks such as React take over the scripting that would otherwise occur on the top level HTML file.

In my opinion, for this library to be viable for most js frameworks, there would need to an NPM library that gives the developer the ability to import the library and use it in their files.

StillOnMyWay commented 2 months ago

I think the author would agree with you, except that he has had an NPM package for quite a while. Here is the link to the installation page - https://hiukim.github.io/mind-ar-js-doc/installation

The examples may show HTML examples, but that may just be the easier example to demo without knowing which framework you're building for.

Package : > npm i mind-ar --

Johnrobmiller commented 2 months ago

This brushes the issue under the rug.

Put yourself in the shoes who discovered MindAR via google. The scroll down to the readme and click on the docs. However, the docs (the page I linked above) does not even mention an NPM package. How would that person know there is an NPM package. The answer is that there's no way for them to know. This is a bug. It's not an engineering bug, but it's still a bug.

Also, I still find is very strange that the default code examples use a style of coding that become outdated several decades ago. You say it's like that so that it can be framework agnostic, but how would a React or Svelt developer actually inegrate what is shown in the docs? It does not seem framework agnistoc to me.