Sprint log

[blahah]

Following @joeyklee's lead, I'm using this issue to log what I do during this sprint.

One comment per day!

[blahah]

Day 1

• filled out the sprint entry survey
• completed moving from personal repo to the slidewinder organisation
• organised the organisation's repositories
• created a shared set of community contribution documentation: http://slidewinder.io/docs. This is for me as much as for potential future collaborators
• documented how to get involved in the project as a coder - including style guide, step-by-step setup, etc.

[blahah]

Day 2

• design: user personas - see Site and app #2
• spec out the code API
• T/BDD - get the tests written, they'll guide development up to the end of the week (part done - turned out to be a big task that required lots of infrastructure to make it work effortlessly in future

[blahah]

Day 3

• setup testing infrastructure
• setup coverage analysis
• setup documentation generation (literature programming model)
• spec test descriptions only
• (if time) start actual tests

[blahah]

Day 4

• working through spec, implementing tests and then making them pass 💃 Test infrastructure, tests, CI, coverage and static analysis and more (closes #15) slidewinder#36
  • slide class fully specced, tested and implemented
  • collection class ditto
  • librarian class ditto
• turns out that for some of the above I need a lot of example slides. So I'm gonna prototype the open access figure -> slidewinder slide, to generate a couple of hundred slides for testing

[blahah]

Day 5

• investigated routes to creating open access figure slide database: https://github.com/slidewinder/open_access_figures/issues
• wrote a small utility to help: https://github.com/Blahah/beau-selector
• started writing app getfigures that creates slides from open access papers matching a search query

[blahah]

Day 6

• get getpapers to a working state (although a bit slow)
• use it to generate several collections of test slides for slidewinder https://github.com/slidewinder/open_access_figures
  • tardigrades https://github.com/slidewinder/open_access_figures/tree/master/data/tardigrades
  • tortoises https://github.com/slidewinder/open_access_figures/tree/master/data/tortoise
• speed it up
  • It turned out that xpaths are considerably slower than css queries, at least as implemented in the packages used by beau-selector. Switching to CSS + attribute extraction knocked about 50% off runtime.
  • Ideally it would still be much faster, but at the moment it's tolerable.

[blahah]

Day 7

Today I'm working on my PhD so probably won't do much slidewinder.

[blahah]

Day 8

• incorporate open_access_figures slide sets as test data for slidewinder
• finish implementing spec
• interactive CLI and then
• abstract out searching so we can use e.g. Meteor instead of elasticlunr
• design exercises for GUI: sketches etc
• web/GUI app scaffolding

[blahah]

Day 9 redux

Had to take some days out to deal with other things, so the sprint is being revived at day 9!

• Interactive CLI is part implemented

[blahah]

Day 10

• Implement persistent datastore
• Ship interactive CLI with slide import and search and deck creation

[blahah]

Day 11

• Interactive CLI with deck presentation
• implemented data-driven slides properly

[blahah]

Day 12

• A lot of setup for the webapp:
  • digitalocean instance to run it on
  • compose.io mongodb and elasticsearch with a mongo->elastic transporter - this means we get a nice database and super fast full-text search
  • cloudflare SSL and routing - provides secure connections, protection against DDOS, and caching
  • kadira.io analytics - this measures the internals of the app while its running so we can keep an eye on performance, see what needs tweaking etc.
• Started building out the UI based on @joeyklee's wireframes. Lesson for the future: start with the UI, decide what it needs to be able to do and then design the backend. Did it the other way around this time which has led to a lot of time wasted. Also, learn to make wireframes.
• Did the infrastructure for the web/desktop app, built out the Meteor core, figured out the ridiculously complex deployment. App now lives at http://app.slidewinder.io, although right now it's not that functional.