search

sacode387 / FlowRun

Runnable flowcharts for the web
https://flowrun.io/
Apache License 2.0
46 stars 9 forks source link

Compilation instructions? #1

Closed maubuz closed 2 years ago

maubuz commented 2 years ago

First of all: Thank you so much for this amazing project! I teach computer science at a college in Montreal and I love the idea of "cross-platform Flowgarithm in the browser".

Would it be possible to provide compilation instructions in the Readme? I've successfully compiled the demo project and I can serve it with a basic http server. However, I'm not very familiar with Scala and ScalaJS so I'm wondering if I'm missing something.

I mostly followed the instructions from Haoyi's Hands-on Scala.js and Multi-project builds from scala-sbt.org.

My steps:

> sbt
sbt:flowrun> project demo
sbt:demo> compile
sbt:demo> fastOptJS

The sbt:demo> run command failed in but I was still able to find and serve the files inside FlowRun/demo/target/web/public/main

Am I missing anything else? It seems functional.

sake92 commented 2 years ago

@maujac you're welcome, glad you like it!
Love to have any feedback haha.
So glad you are using it in your teachings! 🎉 😃

I've added a new page with instructions: https://github.com/sacode387/FlowRun/blob/master/CONTRIBUTING.md
Hope it is enough, at least for now.

The run commands is like nodejs myscript.js. It runs a console application (which we don't have here).
Here we need just to compile the scala code to JS, so demo/fastLinkJS is enough.
The browser loads the necessary JS code.

If you have any other questions please do ask!
Or if you prefer chat: https://discord.com/channels/955759293259472936/959436265915314236

maubuz commented 2 years ago

Thank you very much! The instructions are very clear.