themokaproject.github.io/index.html at master · themokaproject/themokaproject.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
    <link rel='stylesheet' type='text/css' href='https://fonts.googleapis.com/css?family=Architects+Daughter'>
    <link rel="stylesheet" type='text/css' href="https://fonts.googleapis.com/css?family=Roboto:regular,medium,thin,italic,mediumitalic,bold" title="roboto">
    <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
    <link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
    <link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />

    <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->

    <title>The Moka Project by themokaproject</title>
  </head>

  <body>
    <header>
      <div class="inner">
        <h1>The Moka Project</h1>
        <h2></h2>
        <a href="https://github.com/themokaproject" class="button"><small>Follow us on</small>GitHub</a>
      </div>
    </header>

    <div id="content-wrapper">
      <div class="inner clearfix">
        <section id="main-content">
          <h1>
            <a name="about-moka" class="anchor" href="#about-moka"><span class="octicon octicon-link"></span></a>About Moka
          </h1>

          <ul>
            <li>An Android application to revolutionize in-room collaboration.</li>
            <li>A JavaScript-based output platform for beautiful realtime rendering.</li>
            <li>A powerful Java/Jade-based backend server for the heavy computation and across devices synchronization.</li>
          </ul>

          <h1>
            <a name="try-it" class="anchor" href="#try-it"><span class="octicon octicon-link"></span></a>Try it
          </h1>

          <p>
            You can try Moka by cloning our <a href="http://github.com/themokaproject">GitHub repos</a> or by downloading directly the following zipballs:
          </p>

          <ul>
            <li>Java server (<a href="downloads/moka-server.zip">moka-server.zip</a>)</li>
            <li>Android app (<a href="downloads/moka-app.apk">moka-app.apk</a>)</li>
            <li>HTML5/Javascript platform (<a href="downloads/moka-platform.zip">moka-platform.zip</a>)</li>
          </ul>


          <h1>
            <a name="public-api" class="anchor" href="#public-api"><span class="octicon octicon-link"></span></a>Public API
          </h1>

          <p>
            Moka has a public API for you to be able to interact and make requests with our very own system. We use a RESTful-based server architecture, allowing you to make the following requests:
          </p>
          <ul>
            <li>
              <pre style="display:inline-block;">@GET $SERVER_IP/api/user/list<br>Returns the list of users currently connected to the system.</pre>
            </li>
            <li>
              <pre style="display:inline-block;">@GET $SERVER_IP/api/item/list<br>Returns the list of items currently added to the system.</pre>
            </li>
            <li>
              <pre style="display:inline-block;">@GET $SERVER_IP/api/history/list<br>Returns the list of every action that occured in the system.</pre>
            </li>
            <li>
              <pre style="display:inline-block;">@POST $SERVER_IP/api/item/{id}/image<br>Allows to add an image resource (.jpg format) for the item<br>at the given {id}.</pre>
            </li>
            <li>
              <pre style="display:inline-block;">@GET $SERVER_IP/api/item/{id}/image<br>Returns the image of the item whose id is {id}.</pre>
            </li>
          </ul>
          <p>
            Please note that we currently only support JSON format, but we totally plan to support other formats in a very near future.
          </p>

          <h1>
            <a name="the-moka-project-in-action" class="anchor" href="#the-moka-project-in-action"><span class="octicon octicon-link"></span></a>The Moka Project in action
          </h1>

          <p>
            <img src="images/moka_app_1.png" alt="Moka App">
            <img src="images/moka_app_2.png" alt="Moka App">
          </p>

          <iframe width="560" height="315" src="http://www.youtube.com/embed/tfVMMNW86vo?rel=0" frameborder="0" allowfullscreen></iframe>

          <h1>
            <a name="credits-and-license" class="anchor" href="#credits-and-license"><span class="octicon octicon-link"></span></a>Credits and License
          </h1>

          <p>
            Credits go to Thomas Barthélémy <a href="https://github.com/tbarthel-fr">https://github.com/tbarthel-fr</a>, Vincent Barthélémy <a href="https://github.com/vbarthel-fr">https://github.com/vbarthel-fr</a>, Thomas Keunebroek <a href="https://github.com/tkeunebr">https://github.com/tkeunebr</a> and Alexandre Masciulli <a href="https://github.com/amasciul">https://github.com/amasciul</a>.
          </p>

          <p>Licensed under the Beerware License:</p>

          <pre style="white-space: -moz-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">You can do whatever you want with this stuff.<br>If we meet some day, and you think this stuff is worth it, you can buy us a beer (or basically anything else) in return.</pre>
        </section>

        <aside id="sidebar">
          <p style="margin-left:50px;"><img src="images/logo.png" alt="Moka Logo"></p>
        </aside>
      </div>
    </div>

  </body>
</html>