Code Monkey home page Code Monkey logo

slide_machine's Introduction

Simple Webmachine / Riak application for presenting slides

This is very much a work in progress and as such might not be useful for anybody at all.

Resources:

  • slide => individual slide authored in markdown?
  • deck => collection of slides with an implied ordering.
  • library => collection of all decks
  • author => author of a particular deck of slides

TODO

Integrate Riak - retrieve slide contents from riak backend.
  • look at how to bundle a markdown parser in a library or application?

  • integration tests for OTP applications? Need something!

  • need way of packaging javascript

  • start with modeling a basic slide and presenting it using backbone.js and html.

  • backbone.js UI presenting a deck

  • riak storage of slides, needs a single Riak node setup

  • webmachine rest interface to the resources, slide and deck

  • backbone.js UI presenting a library

  • be nice to have a script to generate a new resource, similar to rails?

BUGS: (Not that there are any)

  • /slide/id works but want /slide to fail more gracefully.

Layout

You should find in this directory:

README.markdown : this file
Makefile : simple make commands
rebar : the Rebar build tool for Erlang applications
rebar.config : configuration for Rebar
apps : Erlang modules that make up this application
/slide_machine_web : webmachine application
  /deps - the erlang library dependencies for the web application
  /ebin - compiled beam files for the erlang VM
  /src  - Erlang source code
  /priv - is where all the html and Javascript files are placed.
/slide_machine_core : core logic to mediate between web app and riak db
  /deps - the erlang library dependencies
  /ebin - compiled beam files for the erlang VM
  /src  - Erlang source code

Helpful Resources

Erlang Testing

https://github.com/eproxus/meck

Basically the root url shows a preview collection of slide decks

|------------------------------------------------------------
|                                                           |
|      |------|              |------|                       |
|      | deck |              | deck |                       |
|      |------|              |------|                       |
|                                                           |
|                                                           |
|      |------|              |------|                       |
|      | deck |              | deck |                       |
|      |------|              |------|                       |
|                                                           |
|                                                           |
|      |------|              |------|                       |
|      | deck |              | deck |                       |
|      |------|              |------|                       |
|                                                           |
|------------------------------------------------------------

Clicking on a deck brings you to Overview of Deck. show author, summary and TOC ie slide names.

|------------------------------------------------------------
|            |                                              |
| Title      |          Current Slide                       |
| 1.         |                                              |
| 2.         |                                              |
| 3.         |                                              |
| etc        |                                              |
|            |                                              |
|            |                                              | ===> next slide
|            |                                              |
|            |                                              |
|            |                                              |
|            |                                              |
|            |                                              |
|            |                                              |
|            |                                              |
|            |           footer: Title                      |
|------------------------------------------------------------

You can click on each slide on the side to go to that one.

There is a backwards and forwards buttons to navigate.

Deck => individual presentation, contains many slides Slide => individual page in a presentation

Player => handles state of current presentation, ie current slide, current deck.

Have multiple views backed by the same model or collection? Provide a DeckThumbnailView and a DeckView backed by the decks collection. One shows an image, or author name, while the other shows just the title?

What does the tagName and ClassName within a view do again?

NOTES: Render all 3 views on the page when the main page is hit, hide any that we don't need.

Javascript Questions:

  • what is the pattern for JS object initialisation? How does it interact with JSON?

Riak Questions:

  • how should the data modeling work?

Get the keys

curl -v http://127.0.0.1:8098/buckets/decks/keys?keys=true

Keep everything in a single bucket.

eg /riak/decks/

Within a Deck we have all the slides as a single document, for now!

OTP Architecture Questions:

  • where do I start the core app from? does the web start it or do I need a supervisor for both web and core?
  • add rebar target to generate a release and start that up.
  • draw diagram of supervision tree for app.

Supervision Tree

slide_machine_core slide_machine_web pool (riak) | | | | | | slide_machine_core_sup slide_machine_web_sup pooler_sup | | | | | ------------------- slide_machine_core_server slide_machine_web_server | | pooler_pool_sup pooler

slide_machine's People

Contributors

tmcgilchrist avatar chinnurtb avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.