cluster-broccoli icon indicating copy to clipboard operation
cluster-broccoli copied to clipboard
verified publisher icon FRosner

Update README with developer guide

Open pliguori opened this issue 9 years ago • 3 comments

For the non-docker version,

  • It's not mentioned anywhere that you also need to install play
  • it's not explained how to start it after packaging it with activator

pliguori avatar Aug 21 '16 10:08 pliguori

Thanks @pliguori. You are talking about something like a developer guide? To get you started for development? Or a user getting started?

You don't need activator, sbt is perfectly fine. Activator is just sbt on drugs.

FRosner avatar Aug 22 '16 07:08 FRosner

I'm talking more about a developer guide, since a user should just use the dockerized version, right? But if you want to develop and you're not familiar with how scala/play normally work, you have to spend some time to get it. I assume just installing sbt/play may be fine, but if you don't write it, I don't know :)

pliguori avatar Aug 23 '16 06:08 pliguori

@ishmeetkaur you should be able to develop the UI using the docker image and mounting the public folder from your filesystem.

docker run --net host -it -v $(pwd)/public:/cluster-broccoli/public --entrypoint bash frosner/cluster-broccoli

When you are inside the container, you can use sbt run or activator run. Then all changes you make to the UI (files inside public) will get updated automatically.

FRosner avatar Sep 20 '16 13:09 FRosner