How to get a dev environment up and running

TimoStaudinger commented 6 years ago

I was trying to get a dev. environment for Jarvis up and running yesterday to submit a PR. Note that I haven't worked on Webpack plugins so far, so the points below may be totally idiotic.

However, I had some issues getting started, and maybe some other people are facing the same problems. Pointing them out in order to make getting started with contributing a little simpler for them. :ok_hand:

How do I run Jarvis in a test/sandbox environment? Kicking off the dev server via npm run dev does launch the dashboard at port 3000, however completely without data, which makes testing it somewhat pointless.
I tried to create a sample webpack project to integrate the dev instance of Jarvis, however Webpack doesn't seem to follow symlinks to plugins, so npm link ... seems out of question.
Trying to build Jarvis via npm run build (on Windows) failed due to some extra apostrophes in the scripts section of package.json: Error: Cannot find module 'C:\git\jarvis\'.\src\client\webpack.config.js''. Removing the apostrophes resolves the issue. Is that a bug, or just an issue with my environment?
Trying to run dashboard the locally built version of Jarvis fails, opening it in Chrome results in the following error: Uncaught SyntaxError: Unexpected token <. It seems like Chrome is trying to execute the index.html file as a JS file? Could that be caused by the way the files are served by polka?

Maybe someone can shed some light on those points. If so, having a quick getting started guide may be helpful, perhaps in the read-me or contributing.md?

Sunshine168 commented 6 years ago

oooooh 💔, ,seem like #60 , waiting for Investigating provider a quick way fix in current workspace

because#33 custom port support if you change document.location.port to 1337 it will work

And i thought 'C:\git\jarvis\'.\src\client\webpack.config.js'' may bug in windows

About contributing, discussing in #79 , will be added soon

zouhir commented 6 years ago

am going to push a PR for this ;) I added option to dev URL so you can get socket connected and running in your dev page: localhost:3000/?force_socket_port=1337

zouhir commented 6 years ago

please check the readme now if it makes sense!

TimoStaudinger commented 6 years ago

Got it up and running, at least in dev. mode. Haven't tried doing a prod. build so far.

And i thought 'C:\git\jarvis\'.\src\client\webpack.config.js'' may bug in windows

This issue still exists for me. Removing the quotes makes it work fine. Would that break it for other environments? Anyone got a Linux/OSX machine to test it on?

zouhir commented 6 years ago

I have a fix for this going this morning!

zouhir commented 6 years ago

should be fixed by #110 please repoen if not so!

zouhir / jarvis

How to get a dev environment up and running #104