Feature/offline

[haf]

The aim of the PR is to make FsReveal function without internet access. This means we need to pull in all of the code as a single compilation unit:

• Compile JS
• Compile CSS
• Pull in fonts locally
• Pull in bootstrap locally
• Pull in RevealJS locally
• Ensure we can resolve fonts when running ./build.sh from master, serving with Suave
• Ensure we can CSS
• Optimise JS
• Optimise CSS
• Upgrade all dependencies
  • Suave
  • FAKE
  • OctoKit
• Add babel for ECMAScript 6/7 support
• Add webpack for compilation and working with JS

[haf]

What's the way to test if what I've done works? There are no docs what so ever about how to run this thing in dev mode...?

[forki]

good question. did not do this for very long time.

probably by copying things manually in place

[haf]

While you have a look at that, here are the main changes:

• Introduce a new build tool for building compressed JS – http://yarnpkg.com/
• Change generation to ./dist
• Change templating to ./dist/index.html which is where https://github.com/ampedandwired/html-webpack-plugin puts it after injecting all the required JS
• Add OfflinePlugin so that presentations can be presented without even a broken WIFI connection
• Adding chunking with chunk hashes for long term caching
• Pulling in reveal.js directly from paket-files, exposing it as a browser global and initialising it
• Pulling in all currently enabled plugins with Webpack rather than with reveal.js, so that they are turned on by default (needs testing – QA – forki?)
• I haven't yet found how to start it all (but I'll peruse the build.fsx file shortly)
• MathJax – I pulled in the node package rather than their CDN (which is failing often for me)
• Added source maps so that reveal.js can be properly debugged
• Added source maps for our own new template.js which enabled me to move all logic out of the HTML file.

This will make it:

• Easier to upgrade reveal.js because all that's needed is to bump the paket dependency; no more manual copying
• Easier to provide server-side rendering if needed, because it's now loaded through node
• Easier to track the JS dependencies

QA needed on:

• Paths and copying files around – needs docs, too
• Regeneration of slides and injecting them into the file
• Changing the layout – I may have removed the location where that's templated

Help needed on:

• The above and also
• How to start it in dev mode

AFK for a while now; I need to write my presentation too. Which btw I could hold for the F# community too; intro to Kafka.

[forki]

upgrading reveal was always easy.

https://github.com/fsprojects/FsReveal/blob/develop/paket.dependencies#L6
so it was only a git push on the reveal clone (please note we explicitly maintain the fork, since we often are a couple of commits in front of reveal.js master)

[haf]

I did notice a strange reveal.js-[GITHASH] folder in the fork; is that where you want me to use the files from? Why not just merge it into the files of the actual repo?

[forki]

suave is taken via paket from nuget.

[forki]

urgs!?

[haf]

Yup, the wonderful world of JS dev

[forki]

why would we need it?

[haf]

I don't know. JS pulls in the world and I'm using the "standard" setup for css/html.

[forki]

"as a NuGet package. That package..."

[haf]

Done

[forki]

"when you want to"

[forki]

where is this coming from?

[haf]

@kimsk @troykershaw What css file am I missing? Only getting white BG:

[kimsk]

It looks like the reveal.js css theme is missing. Those files are something like css/theme/night.css in reveal.js.

[haf]

@kimsk Thanks; the last two issues are:

• showTip/hideTip are expected to be globals, rather than composed functions – I've placed the tips.js file inside the bootstrapping file but haven't found where they are being used (need to get on with presentation now!). Any direction towards fixing that would be excellent.
• The overview mode looks like this when you press O and then right arrow twice:

[ErikSchierboom]

I've just tested this on my MacBook, and here are my findings:

• The README doesn't state that you should run build.cmd or build.sh before running yarn run build. If you don't do that, you get errors like the following error:

ERROR in ./template.js
Module not found: Error: Cannot resolve 'file' or 'directory' ../../paket-files/fsprojects/reveal.js/css/reveal.css in /Users/erikschierboom/Programming/FsReveal/src/FsReveal
 @ ./template.js 3:0-64 43:2-66

Having run build.sh first and then the yarn commands fixes it.

• The README doesn't mention the fact that you can run in watch mode using yarn run watch

• If I open the dist/index.html file after successfully building, it unfortunately doesn't work. It complains that three files cannot be found:

• dist/css/custom.css
• common.<..>.js
• app.<..>.js

[haf]

You need to run Suave like in my screenshots above... Could you do that?

[ErikSchierboom]

@haf Sorry, but how do I do that? If I run a local node http-server, things don't work:

I'm a bit confused a to why Suave would be necessary. Wasn't the whole point being that it could run offline?

[haf]

Yes, it runs offline from the point of view of your laptop. Just because we start a local web server, we don't have internet.

Today we can't show the presentation without internet.

I'll see what I can whip together in the form of a readme.

[ErikSchierboom]

@haf Okay, clear. But shouldn't running http-server in the dist directory be working? In my screenshot above, you can see that it didn't.

A readme would be much appreciated!

[haf]

I've updated the READMEs with that information now @ErikSchierboom

[haf]

How to test:

check out the two branches. First build this PR with ./build NuGet then add paket.local in the other PR (see README.md) to point to the new nuget, then do .paket/paket.exe restore to use it. Now you can run ./build in the other PR to run the server.

[haf]

I think it's worth merging now and fixing remaining issues together with the community: e.g. the pretty-printed code lines being slightly off, bumping reveal.js in the fsprojects org and going through its themes, removing downloads from googleapis.com. Also themes and speaker notes aren't really working, but now I have to write my presentation! :)

[ErikSchierboom]

Thanks @haf!

[dustinlacewell-wk]

Any chance of this?

[haf]

Need someone to pick up the slack. I don't have the bandwidth to complete this refactor (but it's working now, so someone just needs to merge it and test it in full)