Open source project

bartkozal · Apr 21, 2018 · 2e81e98 · 2e81e98
1 parent 6a82d97
commit 2e81e98
Show file tree

Hide file tree

Showing 11 changed files with 181 additions and 6 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Bart Kozal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,21 +1,21 @@
 # Jottings
 
+![intro](https://github.com/bkzl/jottings/raw/master/app/assets/images/img-readme.gif)
+
 Dependencies:
 
 - Ruby
 - Node
 - PostgreSQL
 - Redis
 - MongoDB
-- ChromeDriver
 
 ## Setup
 
-1. Clone jottings-sharedb first
-2. Clone this repository
-3. Run `bundle install`
-4. Run `rails db:setup`
-5. Run `rails t` to ensure that tests pass
+1. Set up [jottings-sharedb](https://github.com/bkzl/jottings-sharedb)
+2. Run `bundle install`
+3. Run `rails db:setup`
+4. Run `rails t`
 
 ## Development
 

diff --git a/app/assets/images/img-readme.gif b/app/assets/images/img-readme.gif
diff --git a/static/favicon-16x16.png b/static/favicon-16x16.png
diff --git a/static/favicon-32x32.png b/static/favicon-32x32.png
diff --git a/static/index.html b/static/index.html
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <title>Real-time collaboration in Markdown - Jottings</title>
+  <meta property="og:url" content="//jottings.co">
+  <meta property="og:type" content="website">
+  <meta property="og:title" content="Jottings">
+  <meta property="og:description" content="Real-time collaboration in Markdown">
+  <meta property="og:image" content="/logo.png">
+  <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
+  <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
+  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Gentium+Basic:400,700|Open+Sans:300,400,700|Inconsolata">
+  <link rel="stylesheet" href="/style.css">
+</head>
+
+<body>
+  <div class="sticky-footer">
+    <div class="container">
+      <div class="navbar">
+        <div class="grid grid-pair">
+          <div class="grid-item 1/1">
+            <ul class="navbar-menu">
+              <li>
+                <img src="/logo.svg" alt="Logo" class="navbar-brand">
+              </li>
+              <li>
+                Jottings
+                <sup class="text-muted">Beta</sup>
+              </li>
+            </ul>
+          </div>
+        </div>
+      </div>
+
+      <div class="text-center">
+        <h1 class="margin-3/1-top margin-2/1-bottom text-light">
+          Real-time collaboration in Markdown
+        </h1>
+
+        <video src="/intro.mp4" poster="/poster.png" autoplay="autoplay" loop="loop" class="video"></video>
+
+        <div class="box box-brand full-width">
+          <a href="https://github.com/bkzl/jottings" class="btn btn-outline btn-white">Start writing right now</a>
+        </div>
+
+        <h2 class="h3">Key features</h2>
+
+        <div class="grid grid-center margin-2/1-bottom">
+          <div class="grid-item 1/2">
+            <ul class="list-reset">
+              <li class="margin-bottom">Auto formatting Markdown</li>
+              <li class="margin-bottom">Full-screen mode</li>
+              <li>Grouping documents</li>
+            </ul>
+          </div>
+
+          <div class="grid-item 1/2">
+            <ul class="list-reset">
+              <li class="margin-bottom">Real-time syncing</li>
+              <li class="margin-bottom">Autosave</li>
+              <li>Bookmarks</li>
+            </ul>
+          </div>
+        </div>
+      </div>
+
+    </div>
+
+    <div class="footer padding-vertical">
+      <p>
+        Development of Jottings is on hold. The app is
+        <a href="https://github.com/bkzl/jottings">open-source</a>. Follow
+        <a href="https://twitter.com/_bkzl">@_bkzl</a>
+        and
+        <a href="https://twitter.com/_mac">@_mac</a> for further updates.
+      </p>
+    </div>
+  </div>
+
+  <a href="https://github.com/bkzl/jottings" class="github-corner" aria-label="View source on Github">
+    <svg width="80" height="80" viewBox="0 0 250 250" style="fill:#4990e2; color:#fff; position: absolute; top: 0; border: 0; right: 0;"
+      aria-hidden="true">
+      <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
+      <path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
+        fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
+      <path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
+        fill="currentColor" class="octo-body"></path>
+    </svg>
+    <style>
+      .github-corner:hover .octo-arm {
+        animation: octocat-wave 560ms ease-in-out;
+      }
+
+      @keyframes octocat-wave {
+        0%,
+        100% {
+          transform: rotate(0);
+        }
+        20%,
+        60% {
+          transform: rotate(-25deg);
+        }
+        40%,
+        80% {
+          transform: rotate(10deg);
+        }
+      }
+
+      @media (max-width: 500px) {
+        .github-corner:hover .octo-arm {
+          animation: none;
+        }
+        .github-corner .octo-arm {
+          animation: octocat-wave 560ms ease-in-out;
+        }
+      }
+    </style>
+  </a>
+
+  <script>
+    (function (i, s, o, g, r, a, m) {
+      i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
+        (i[r].q = i[r].q || []).push(arguments)
+      }, i[r].l = 1 * new Date(); a = s.createElement(o),
+        m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
+    })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
+
+    ga('create', 'UA-51355575-7', 'auto');
+    ga('send', 'pageview');
+  </script>
+</body>
+
+</html>
diff --git a/static/intro.mp4 b/static/intro.mp4
diff --git a/static/logo.png b/static/logo.png
diff --git a/static/logo.svg b/static/logo.svg
diff --git a/static/poster.png b/static/poster.png
diff --git a/static/style.css b/static/style.css