microsoft / showwhy

MIT License
207 stars 29 forks source link

Incopleatre 'just get going' instructions #253

Closed elikling closed 1 year ago

elikling commented 2 years ago

The set up instructions assume a high level of technical competance as an application developer. Peopel like myself who are mainly staticticians with some knowledge of UNIX and Python will (am) straggle. for istnace it took me time to realize that one needed to

git clone "https://github.com/microsoft/showwhy"
cd showwhy

before

sudo yarn install
sudo yarn build

even so I get error messages I cannot handle. I tired UBUNTU18 and UBUNTU20 and spend two days trying differnet fixes and instalations of supporting software - I have a feeling I am missing something - is there a website where I can just try it or is there a simpel "install" I can run

eli.kling@avanade.com https://www.linkedin.com/in/elikling/

darthtrevino commented 2 years ago

Hey @elikling, I'm just noticing your comment here, I apologize for the delay!

Are you running on Ubuntu directly or in WSL on a Windows machine? If you just want to fire up the application to try it out, I'd recommend avoiding yarn and using Docker directly:

docker-compose --profile all up

Once all the containers are initialized, which on my machine takes a couple of minutes, you should see a log message: webpack-dev-server] Loopback: http://localhost:3000/, which means you can visit the webapp at localhost:3000 in a browser.

You'll need to install Docker - that website has a downloadable for Windows, or you can follow the Linux instructions here

emrekiciman commented 1 year ago

@darthtrevino , is your recommendation the same as the "local deployment" instructions here? https://github.com/microsoft/showwhy/blob/main/docs/deployment/LOCAL_DEPLOY.md

darthtrevino commented 1 year ago

No, that's a bit heavyweight of a solution for running locally. That's more for testing out the infra. I've added some top-level notes in the README that recommend docker explicitly for just firing up the app.

elikling commented 1 year ago

I tried following the instruction above both on a windows VM and an Ubuntu and am still encountering issues. I consulted a Kubernetes expert and also he could not solve the issues. We will assign one of our AI engineering grands to try and figure out how to get this going.