Feature/offline #103

haf · 2016-11-09T13:40:39Z

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

Starting work on fsprojects#101

Ref fsprojects#101

haf · 2016-11-09T13:53:00Z

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 · 2016-11-09T13:55:11Z

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

probably by copying things manually in place

haf · 2016-11-09T14:01:48Z

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 · 2016-11-09T14:19:56Z

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 · 2016-11-09T14:21:51Z

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 · 2016-11-09T14:38:12Z

suave is taken via paket from nuget.

forki · 2016-11-09T15:37:13Z

README.md

+
+The node modules take care of bundling all the JS dependencies. You don't need
+anything other than Yarn to compile, but some of them are dependent on having a
+binary called 'python2' on your PATH.


Yup, the wonderful world of JS dev

why would we need it?

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

forki · 2016-11-09T15:37:51Z

README.md

+`./src/FsReveal/template.{html,js}` is the entry point for webpack during
+packaging.
+
+When you've performed a change to the repo, it's all packaged as a nuget. That


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

forki · 2016-11-09T15:38:09Z

README.md

+# npm install -g yarn
+yarn install --ignore-engines
+yarn run build
+# when you wanna test your changes:


"when you want to"

forki · 2016-11-09T15:38:22Z

README.md

+### Dev
+
+```
+pyenv local 2.7.10


where is this coming from?

haf · 2016-11-09T16:55:15Z

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

kimsk · 2016-11-12T20:08:01Z

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

haf · 2016-11-13T15:42:17Z

@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 · 2017-01-18T18:04:10Z

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 · 2017-01-18T19:28:56Z

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

ErikSchierboom · 2017-01-18T20:19:24Z

@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 · 2017-01-19T08:40:39Z

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 · 2017-01-19T08:48:49Z

@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 · 2017-05-22T06:43:10Z

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

haf · 2017-05-22T08:20:00Z

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 · 2017-05-22T08:30:46Z

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 · 2017-05-22T09:46:48Z

Thanks @haf!

Fix build on windows

dustinlacewell-wk · 2017-12-08T21:15:36Z

Any chance of this?

haf · 2017-12-10T12:26:11Z

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)

haf added 3 commits November 9, 2016 10:49

[infra] make build.sh executable

37471e9

Starting work on fsprojects#101

Adding bundled/minimized/offline package version

b1579ba

Ref fsprojects#101

Documenting building

702b089

Cleanups and correcting css/custom.css path

99e7424

Document where the fsx files are

1ee192b

[infra] OS X -> Linux on travis

1e5bc10

haf added 3 commits November 9, 2016 15:25

Remove stray package.json

36c6561

Removing stray yarn.lock

39ebf2e

[infra] paket update

8c4cfbd

haf added 6 commits November 9, 2016 15:51

More docs, fixing path

d8c965a

changing nuget

78aa58a

Bring the tool

4979cb0

Move it all into tools instead

3009c06

Compile js

4d8fe91

location of template

631c414

forki reviewed Nov 9, 2016

View reviewed changes

haf added 7 commits November 9, 2016 16:46

Dist folder update

d91b4ea

Adding css-loader

eee8dee

hacking around w style sheets

4f9620b

wording

b007c26

Adding in fonts locally

a1cd55f

Pushing tips.js into the global scope with scripts-loader

4a13dc8

Disable MathJax for now

0e3d363

Styles work, but something is still off

fee664b

ErikSchierboom mentioned this pull request Jan 18, 2017

Offline support? #101

Open

haf added 2 commits May 22, 2017 08:30

Minor update from running yarn

0344694

Updating readme with instructions on how to get started

88a4861

haf added 5 commits May 22, 2017 08:53

Whitespace

2687862

Bumping F# dependencies

9995b22

Port to Expecto, clean up build

bfe719f

Runs expecto

ac0ccd1

Tightening build rules a bit

f6998dd

F# tooltips work again

a766b10

tpetricek and others added 5 commits May 22, 2017 13:42

Fix build on windows

470d8f0

Merge pull request #1 from tpetricek/offline-develop

9a89724

Fix build on windows

Fix createSlides.fsx

3687f64

Windows

1e84357

Relative path

869e3e8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/offline #103

Feature/offline #103

haf commented Nov 9, 2016 •

edited

Loading

haf commented Nov 9, 2016

forki commented Nov 9, 2016

haf commented Nov 9, 2016 •

edited

Loading

forki commented Nov 9, 2016

haf commented Nov 9, 2016

forki commented Nov 9, 2016

forki Nov 9, 2016

haf Nov 9, 2016

forki Nov 9, 2016

haf Nov 9, 2016

forki Nov 9, 2016

haf Nov 9, 2016

forki Nov 9, 2016

forki Nov 9, 2016

haf commented Nov 9, 2016

kimsk commented Nov 12, 2016

haf commented Nov 13, 2016

ErikSchierboom commented Jan 18, 2017

haf commented Jan 18, 2017

ErikSchierboom commented Jan 18, 2017

haf commented Jan 19, 2017 •

edited

Loading

ErikSchierboom commented Jan 19, 2017

haf commented May 22, 2017

haf commented May 22, 2017

haf commented May 22, 2017 •

edited

Loading

ErikSchierboom commented May 22, 2017

dustinlacewell-wk commented Dec 8, 2017

haf commented Dec 10, 2017 •

edited

Loading

Feature/offline #103

Are you sure you want to change the base?

Feature/offline #103

Conversation

haf commented Nov 9, 2016 • edited Loading

haf commented Nov 9, 2016

forki commented Nov 9, 2016

haf commented Nov 9, 2016 • edited Loading

forki commented Nov 9, 2016

haf commented Nov 9, 2016

forki commented Nov 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haf commented Nov 9, 2016

kimsk commented Nov 12, 2016

haf commented Nov 13, 2016

ErikSchierboom commented Jan 18, 2017

haf commented Jan 18, 2017

ErikSchierboom commented Jan 18, 2017

haf commented Jan 19, 2017 • edited Loading

ErikSchierboom commented Jan 19, 2017

haf commented May 22, 2017

haf commented May 22, 2017

haf commented May 22, 2017 • edited Loading

ErikSchierboom commented May 22, 2017

dustinlacewell-wk commented Dec 8, 2017

haf commented Dec 10, 2017 • edited Loading

haf commented Nov 9, 2016 •

edited

Loading

haf commented Nov 9, 2016 •

edited

Loading

haf commented Jan 19, 2017 •

edited

Loading

haf commented May 22, 2017 •

edited

Loading

haf commented Dec 10, 2017 •

edited

Loading