search

foam-framework / foam

Feature-Oriented Active Modeller
Apache License 2.0
787 stars 55 forks source link

Document working demos/not working #537

Open Meai opened 8 years ago

Meai commented 8 years ago
  1. Forgive me if I set up foam incorrectly but I spent quite a few hours on it now. To me it seems only the calculators and the Phone catalog actually work (and some other exceptions, like the hello world) I would intuitively say that 80% dont work. Also if I build the acalc, the build output doesn't work either ("Unknown Model: foam.i18n.MessagesInjector in GlobalController")
  2. Maybe I also did the Todoapp tutorial wrong, but beginning with the DAO stage the steps dont do anything for me (changes dont persist to localstorage) http://foam-framework.github.io/foam/tutorial/todo/4-dao/
  3. There is a foam2 repo in your organization, this strongly implies that the current repo wont be maintained for much longer.

I believe these problems could potentially scare users and developers away.

kgrgreer commented 8 years ago

There are two good demos to check to make sure that you have everything setup correctly:

  1. http://localhost:8000/index.html?model=foam.demos.empire.Preso3#position=0

This loads all 25 slides of my "Introduction to FOAM" slideshow all at once, and many slides contain multiple demos, so in the end, this runs over 40 demos all at once.

  1. http://localhost:8000/demos/DemoCat.html

This is an extensive catalogue of demos which are routinely tested and maintained. They all work.

Any demo that is not listed in the DemoCat may not be up to date or still relevant. If you find any demos that don't work, please file a ticket and we'll either fix or remove it.

What browser are you using?

Are you running a local HTTP server, like is described here: http://foam-framework.github.io/foam/tutorial/todo/0-intro/

If you run the prebuilt TODO app, does it work for you: http://localhost:8000/index.html?model=foam.tutorials.todo.TodoApp

We have recently started working on foam2, but all of our current customers are using foam1 and we will continue to support them (and are still adding features to foam1). The main reason for foam2 is to support a more modular design so that our iOS/Swift and Android/Java support don't weigh-down the web version. For web developers, the biggest difference is the UI library, which is called U2. U2 is compatible with foam1, and is in the foam1 repository now. So provided that you develop your UI's with U2 (foam.u2) instead of U1 (foam.ui), you'll have a very easy time jumping to U2 when it's ready. Other advantages of foam2 include near 100% testing code coverage and complete documentation.

Thanks you very much for reporting your issues. I would like to quickly address them, either though code or documentation, so that others won't have the same problems. Please keep the issue reports coming.