Document that it's pre-compiled on npm/yarn about neo4-js HOT 5 CLOSED

Ah, I just discovered (by npm installing on a whim) that you have actually done this. I amend my issue to be "Please document that you can just require this in node." It wasn't clear to me from the README that the npm/yarn version of this is compiled. And I think that matters a lot. Like I said before, I wasn't willing to use this if I had to jump through hoops.

from neo4-js.

Hi, first of all thanks for showing interest in my library and giving me feeback!
I'm quite new to open source and publishing a library, so this is actually not an easy topic for me. The docs aren't nowhere complete yet, it's quite hard for me to think about all the different approaches and setups. I'll try to add this to the documentation starting with next week!

But I would be more than happy if you would create a pull request for the docs ;)

from neo4-js.

Yeah, there's no doubt that the javascript community is extremely fragmented. I think you can probably assume there's 3 major audiences for something like this: node.js, client-side via babel + some sort of build tool (gulp, grunt, webpack, etc.), and more traditional client-side usage via <script> and window.thing. But I don't think you need to go into too much detail about various setups. The thing I think is worth pointing out is that the version of this library you get when you yarn add or npm install is the not the version you see on Github (e.g. there's no "src" directory, and instead there's a "lib" with compiled code).

from neo4-js.

But I think neo4-js just makes sense for the forst audience. I mean it should be possible, theoretically, to run neo4-js in your client app directly in the browser of the user, but as you need to provide the bolt_uri, bolt_port, neo4j-user and the neo4j-password everybody could connect to your database, which is probably not what you want.

I thought about 3 different audiences:
People who are writing their backend in plain javascript; people who are coding with babel; and people who are coding with babel and flow; potentially there might also be a typescript user.

from neo4-js.

I added a part in the README for this here. Hope this helps!

from neo4-js.