Merge pull request #1 from tohjustin/development

v1.0 Completed
tohjustin · Jan 1, 2017 · 117a938 · 117a938
2 parents 0afbce7 + 5f97859
commit 117a938
Show file tree

Hide file tree

Showing 43 changed files with 9,031 additions and 102 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016-2017 Justin Toh
+
+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,13 +1,38 @@
-# pomodoro-timer-pwa
+<p align="center">
+  <a href="https://pomodori-pwa.firebaseapp.com/" target="_blank"><img src="https://pomodori-pwa.firebaseapp.com/static/logo.png"></a>
+</p>
+<p align="center">
+  <a href="https://circleci.com/gh/tohjustin/pomodori/tree/development"><img src="https://circleci.com/gh/tohjustin/pomodori/tree/development.svg?style=shield" alt="CircleCI Build Status"></a>
+  <a href="https://codecov.io/gh/tohjustin/pomodori"><img src="https://codecov.io/gh/tohjustin/pomodori/branch/development/graph/badge.svg" alt="codecov"></a>
+  <a href="https://www.codacy.com?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tohjustin/pomodori&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/f274b8dcf80749ca87618ea340efe0ac" alt="Codacy Badge"></a>
+</p>
+<p align="center">
+  <span>
+    <a href="https://material.io/guidelines/">Material design</a> flavoured pomodoro timer built as a Progressive Web App
+  </span>
+  <br>
+  <span>
+    Powered by <a href="https://vuejs.org/">Vue 2.0</a> + <a href="https://museui.github.io/">Muse-UI</a>
+  </span>
+</p>
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/)
+- [npm](https://docs.npmjs.com/getting-started/installing-node)
+- [Yarn](https://yarnpkg.com/en/docs/install#mac-tab) (optional, alternative to npm)
+
+## Installation
 
-> Pomodoro Timer as a Progressive Web App (PWA)
+``` bash
+git clone https://github.com/tohjustin/pomodori.git
+cd ./pomodori
+yarn # you can use "npm install" instead
+```
 
-## Build Setup
+## Getting Started
 
 ``` bash
-# install dependencies
-npm install
-
 # serve with hot reload at localhost:8080
 npm run dev
 
@@ -24,4 +49,11 @@ npm run e2e
 npm test
 ```
 
-For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
+This project's build setup is scaffolded by the [vue-cli](https://github.com/vuejs/vue-cli) project. For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
+
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2016-2017 [Justin Toh](https://github.com/tohjustin)
diff --git a/circle.yml b/circle.yml
@@ -0,0 +1,7 @@
+machine:
+  node:
+    version: 6
+
+test:
+  post:
+    - bash <(curl -s https://codecov.io/bash)
diff --git a/docs/user-stories.txt b/docs/user-stories.txt
@@ -0,0 +1,23 @@
+-------------------------
+Version 1.0
+-------------------------
+- As a user I can start & pause timer.
+- As a user I can reset the timer.
+- As a user I should hear an alarm when the timer reaches zero.
+- As a user I can acknowledge & stop the alarm.
+- As a user I can configure the timer's working & break duration.
+- As a user I can mute/unmute the app's alarm.
+- As a user I want my device to to be able to vibrate when alarm is active.
+- As a user I can enable/disable the alarm's vibrations.
+- As a user I can add the web application to my mobile device's home screen + launch the app without the browser panel displaying.
+
+-------------------------
+Version 1.1
+-------------------------
+- As a user I can use the app offline.
+
+-------------------------
+Version 1.2
+-------------------------
+- As a user I can have a long break after 4 pomodoro intervals.
+- As a user I can control the amount of pomodoro intervals before I get my long breaks.
diff --git a/index.html b/index.html
@@ -1,8 +1,38 @@
 <!DOCTYPE html>
 <html>
   <head>
+    <!-- Not all browsers implement the manifest yet, however the <meta> tags will help bridge that gap -->
+    <link rel="manifest" href="./static/manifest.json">
+
+    <meta name="mobile-web-app-capable" content="yes">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="application-name" content="Pomodori">
+    <meta name="apple-mobile-web-app-title" content="Pomodori">
+    <meta name="theme-color" content="#2196F3">
+    <meta name="msapplication-navbutton-color" content="#2196F3">
+    <meta name="apple-mobile-web-app-status-bar-style" content="#2196F3">
+    <meta name="msapplication-starturl" content="/">
+
+    <link rel="icon" type="image/png" sizes="512x512" href="/static/icons/icon-512x512.png">
+    <link rel="icon" type="image/png" sizes="384x384" href="/static/icons/icon-384x384.png">
+    <link rel="icon" type="image/png" sizes="192x192" href="/static/icons/icon-192x192.png">
+    <link rel="icon" type="image/png" sizes="152x152" href="/static/icons/icon-152x152.png">
+    <link rel="icon" type="image/png" sizes="144x144" href="/static/icons/icon-144x144.png">
+    <link rel="icon" type="image/png" sizes="128x128" href="/static/icons/icon-128x128.png">
+    <link rel="icon" type="image/png" sizes="96x96" href="/static/icons/icon-96x96.png">
+    <link rel="icon" type="image/png" sizes="72x72" href="/static/icons/icon-72x72.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="512x512" href="/static/icons/apple-icon-512x512.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="384x384" href="/static/icons/apple-icon-384x384.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="192x192" href="/static/icons/apple-icon-192x192.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="152x152" href="/static/icons/apple-icon-152x152.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="144x144" href="/static/icons/apple-icon-144x144.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="128x128" href="/static/icons/apple-icon-128x128.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="96x96" href="/static/icons/apple-icon-96x96.png">
+    <link rel="apple-touch-icon" type="image/png" sizes="72x72" href="/static/icons/apple-icon-72x72.png">
+
     <meta charset="utf-8">
-    <title>pomodoro-timer-pwa</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Pomodori</title>
   </head>
   <body>
     <div id="app"></div>

diff --git a/package.json b/package.json
@@ -24,14 +24,17 @@
     "babel-preset-es2015": "^6.0.0",
     "babel-preset-stage-2": "^6.0.0",
     "babel-register": "^6.0.0",
+    "chai": "^3.5.0",
     "chalk": "^1.1.3",
+    "chromedriver": "^2.21.2",
     "connect-history-api-fallback": "^1.1.0",
+    "cross-spawn": "^4.0.2",
     "css-loader": "^0.25.0",
     "eslint": "^3.7.1",
+    "eslint-config-standard": "^6.1.0",
     "eslint-friendly-formatter": "^2.0.5",
     "eslint-loader": "^1.5.0",
     "eslint-plugin-html": "^1.3.0",
-    "eslint-config-standard": "^6.1.0",
     "eslint-plugin-promise": "^3.4.0",
     "eslint-plugin-standard": "^2.0.1",
     "eventsource-polyfill": "^0.9.6",
@@ -41,6 +44,8 @@
     "function-bind": "^1.0.2",
     "html-webpack-plugin": "^2.8.1",
     "http-proxy-middleware": "^0.17.2",
+    "inject-loader": "^2.0.1",
+    "isparta-loader": "^2.0.0",
     "json-loader": "^0.5.4",
     "karma": "^1.3.0",
     "karma-coverage": "^1.1.1",
@@ -50,22 +55,23 @@
     "karma-sourcemap-loader": "^0.3.7",
     "karma-spec-reporter": "0.0.26",
     "karma-webpack": "^1.7.0",
+    "less": "^2.7.1",
+    "less-loader": "^2.2.3",
+    "lodash": "^4.17.2",
     "lolex": "^1.4.0",
     "mocha": "^3.1.0",
-    "chai": "^3.5.0",
-    "sinon": "^1.17.3",
-    "sinon-chai": "^2.8.0",
-    "inject-loader": "^2.0.1",
-    "isparta-loader": "^2.0.0",
-    "phantomjs-prebuilt": "^2.1.3",
-    "chromedriver": "^2.21.2",
-    "cross-spawn": "^4.0.2",
+    "muse-ui": "^2.0.0-beta.3",
     "nightwatch": "^0.9.8",
-    "selenium-server": "2.53.1",
-    "semver": "^5.3.0",
+    "node-sass": "^4.1.1",
     "opn": "^4.0.2",
     "ora": "^0.3.0",
+    "phantomjs-prebuilt": "^2.1.3",
+    "sass-loader": "^4.1.1",
+    "selenium-server": "2.53.1",
+    "semver": "^5.3.0",
     "shelljs": "^0.7.4",
+    "sinon": "^1.17.3",
+    "sinon-chai": "^2.8.0",
     "url-loader": "^0.5.7",
     "vue-loader": "^10.0.0",
     "vue-style-loader": "^1.0.0",