Merge pull request #2 from mxstbr/cli

Add CLI

Author: mxstbr

.gitignore

@@ -2,3 +2,4 @@ views.db
 node_modules
 .DS_STORE
 coverage
+dist

README.md

@@ -10,17 +10,20 @@ A tiny analytics server with less than 100 lines of code, easy to run and hack a
 
 ## Setup
 
-1. `git clone [email protected]:mxstbr/micro-analytics` to get the repo.
-2. `npm install` to install the dependencies.
-3. `npm start` to start the service.
+```
+npm install -g micro-analytics-cli
+micro-analytics
+```
+
+And that's it! 🎉 The analytics server is now running at `localhost:3000`. (see [`server-setup.md`](./server-setup.md) for instructions on acquiring a server and setting up `nginx` to make this publicly available)
 
-And that's it! 🎉 (see [`deployment.md`](./deployment.md) for deployment instructions)
+> **Note**: You can pass any option to the `micro-analytics` command that you can pass to [`micro`](https://github.com/zeit/micro). As an example, to change the host you'd do `micro-analytics -H 127.0.0.1`
 
 ## Usage
 
 ### Tracking views
 
-To track a view, simply send a request to `/<yourpath>`. If you send a `GET` request, the request will increment the views and return the total views. If you send a `POST` request, the views will increment but you don't get the total views back.
+To track a view, simply send a request to `/<id>`. If you send a `GET` request, the request will increment the views and return the total views for that id. If you send a `POST` request, the views will increment but you don't get the total views back.
 
 This is how you'd track pageviews for a website: (though note that this can be used to track anything you want)
 
@@ -34,13 +37,9 @@ This is how you'd track pageviews for a website: (though note that this can be u
 </script>
 ```
 
-If you just want to get the views for a path and don't want to increment the views during a `GET` request, set `inc` to `false` in your query parameter. (`/<yourpath>?inc=false`)
-
-If you want to get all views for all paths, set the `all` query parameter to `true`. (`/?all=true`)
-
-## Contributing
+If you just want to get the views for an id and don't want to increment the views during a `GET` request, set `inc` to `false` in your query parameter. (`/<id>?inc=false`)
 
-If you run `npm run dev` the server will restart every time you edit the code. Perfect for development of `micro-analytics`!
+If you want to get all views for all ids, set the `all` query parameter to `true`. (`/?all=true`)
 
 ## Built with
 

cli.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+const { exec } = require('shelljs')
+
+exec('npm start -- ' + process.argv.join(' '), {
+  async: true,
+  cwd: __dirname
+})

contributing.md

@@ -0,0 +1,7 @@
+# Contributing
+
+## Local setup
+
+1. Clone the repository with `git clone [email protected]:mxstbr/micro-analytics.git`
+2. Install the dependencies with `npm install` (or `yarn install` if you have `yarn`)
+3. Run the server in dev mode with `npm run dev`, which will restart the server everytime you edit the code.

package.json

@@ -1,21 +1,32 @@
 {
-  "name": "micro-analytics",
-  "version": "0.1.0",
+  "name": "micro-analytics-cli",
+  "version": "0.1.4-4",
   "description": "Public analytics as a Node.js microservice, no sysadmin experience required.",
-  "main": "index.js",
+  "bin": {
+    "micro-analytics": "./cli.js"
+  },
+  "files": [
+    "dist",
+    "cli.js"
+  ],
   "scripts": {
-    "start": "micro src/index.js",
+    "start": "micro dist/index.js",
+    "build": "./node_modules/.bin/async-to-gen src --out-dir dist",
+    "prepublish": "npm run build",
     "dev": "NODE_ENV=development nodemon --config package.json src/index.js",
     "test": "jest"
   },
   "author": "Max Stoiber <[email protected]> (http://mxstbr.com/)",
   "license": "MIT",
+  "repository": "https://github.com/mxstbr/micro-analytics",
   "dependencies": {
     "flat-file-db": "^1.0.0",
     "micro": "6.1.0",
-    "promise": "^7.1.1"
+    "promise": "^7.1.1",
+    "shelljs": "^0.7.6"
   },
   "devDependencies": {
+    "async-to-gen": "^1.3.0",
     "babel-jest": "^18.0.0",
     "babel-plugin-transform-async-to-generator": "^6.16.0",
     "babel-polyfill": "^6.20.0",

deployment.md server-setup.mddeployment.md renamed to server-setup.md

@@ -1,26 +1,35 @@
-# Deployment
+# Server Setup
 
-Deploying this service is a short three step process. This assumes you already have a server with an OS of your choice that runs Node setup, if not refer to the [acquire a server](#acquire-a-server) section.
+Running `micro-analytics` on a server is a simple two step process:
 
-1. Upload the files of the service to your server (you should be able to do this on your own)
-2. Start and daemonize the app with `pm2`
-3. Setup `nginx` as a reverse proxy to make your service publicy accessible
+1. Start and daemonize the app with `pm2`
+2. Setup `nginx` as a reverse proxy to make your service publicy accessible
+
+## Prerequisite: A server
+
+If you don't have a server to run this on yet, here is what I do:
+
+I use and like [DigitalOcean](https://m.do.co/c/d371ed7f99af) (referral link) for my servers. A simple, 5$/month droplet will suffice to run this service reliably. (upgrading to more power in case of big traffic is two clicks away too)
+
+Make sure to choose the `NodeJS x.x.x on 16.04` (where `x.x.x` is the highest version number you can find) one-click app when creating the droplet to get the server fully setup with Node and Ubuntu.
 
 ## Start and deamonize the app
 
-Once all the files for this microservice are uploaded we'll use `pm2` to start and deamonize the app. This means that the app isn't bound to the terminal, and we'll also make `pm2` start the app when the server start.
+Install `micro-analytics` on your server by running `npm install -g micro-analytics-cli` in its shell.
+
+We'll use `pm2` to start and deamonize the app. This means that the app isn't bound to the terminal, and we'll also make `pm2` start the app when the server start. (this avoids the service being down in case your server reboots)
 
-First run `npm install -g pm2` to get `pm2`, then run `pm2 start npm -- start`. This tells `pm2` to run `npm start` in the background.
+First run `npm install -g pm2` to get `pm2`, then run `pm2 start micro-analytics`. This tells `pm2` to run `micro-analytics` in the background.
 
 To make sure our service stays up even if the server reboots we run `pm2 startup ubuntu` (replace `ubuntu` with whatever OS you're using) and `pm2 save`.
 
 ## Set up `nginx`
 
-Get `nginx` by running `sudo apt-get install nginx`, then configure it to reroute all incoming requests to the server to our server.
+Get `nginx` by running `sudo apt-get install nginx`, then configure it to reroute all incoming requests to the server to `micro-analytics`.
 
 Delete the default site from nginx by running `sudo rm /etc/nginx/sites-enabled/default`, then create a new one by running `sudo touch /etc/nginx/sites-enabled/<yoursite>`. (replace `<yoursite>` with your site name)
 
-We want to reroute all requests for any path that come in to our service, so edit the `/etc/nginx/sites-enabled/<yoursite>` file to look like this:
+We want to reroute all requests for any path that come in to `localhost:3000` (where `micro-analytics` is running), so edit the `/etc/nginx/sites-enabled/<yoursite>` file to look like this:
 
 ```nginx
 server {
@@ -37,11 +46,3 @@ server {
 ```
 
 (note that I have no idea what I'm doing here, this was copied from [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-configure-nginx-as-a-reverse-proxy-for-apache))
-
-## Acquire a server
-
-If you don't have a server to deploy this on just yet, here is what I do:
-
-I use and like [DigitalOcean](https://m.do.co/c/d371ed7f99af) (referral link) for my servers. A simple, 5$/month droplet will suffice to run this service reliably. (upgrading to more power in case of big traffic is two clicks away too)
-
-Make sure to choose the `NodeJS x.x.x on 16.04` (where `x.x.x` is the highest version number you can find) one-click app when creating the droplet to get the server fully setup with Node and Ubuntu.

yarn.lock

@@ -99,6 +99,13 @@ [email protected]:
     babylon "^6.11.4"
     magic-string "^0.16.0"
 
+async-to-gen@^1.3.0:
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/async-to-gen/-/async-to-gen-1.3.0.tgz#ec1ab301ca5881de64e8ad654cd96bfd5fcc4366"
+  dependencies:
+    babylon "^6.14.0"
+    magic-string "^0.19.0"
+
 async@^1.4.0, async@^1.4.2:
   version "1.5.2"
   resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a"
@@ -335,7 +342,7 @@ babel-types@^6.16.0, babel-types@^6.18.0, babel-types@^6.20.0, babel-types@^6.21
     lodash "^4.2.0"
     to-fast-properties "^1.0.1"
 
-babylon@^6.11.0, babylon@^6.11.4, babylon@^6.13.0:
+babylon@^6.11.0, babylon@^6.11.4, babylon@^6.13.0, babylon@^6.14.0:
   version "6.14.1"
   resolved "https://registry.yarnpkg.com/babylon/-/babylon-6.14.1.tgz#956275fab72753ad9b3435d7afe58f8bf0a29815"
 
@@ -737,7 +744,7 @@ glob-parent@^2.0.0:
   dependencies:
     is-glob "^2.0.0"
 
-glob@^7.0.3, glob@^7.0.5:
+glob@^7.0.0, glob@^7.0.3, glob@^7.0.5:
   version "7.1.1"
   resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.1.tgz#805211df04faaf1c63a3600306cdf5ade50b2ec8"
   dependencies:
@@ -846,6 +853,10 @@ inherits@2:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de"
 
+interpret@^1.0.0:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.0.1.tgz#d579fb7f693b858004947af39fa0db49f795602c"
+
 invariant@^2.2.0:
   version "2.2.2"
   resolved "https://registry.yarnpkg.com/invariant/-/invariant-2.2.2.tgz#9e1f56ac0acdb6bf303306f338be3b204ae60360"
@@ -1417,6 +1428,12 @@ magic-string@^0.16.0:
   dependencies:
     vlq "^0.2.1"
 
+magic-string@^0.19.0:
+  version "0.19.0"
+  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.19.0.tgz#198948217254e3e0b93080e01146b7c73b2a06b2"
+  dependencies:
+    vlq "^0.2.1"
+
 [email protected]:
   version "1.0.11"
   resolved "https://registry.yarnpkg.com/makeerror/-/makeerror-1.0.11.tgz#e01a5c9109f2af79660e4e8b9587790184f5a96c"
@@ -1732,6 +1749,12 @@ read-pkg@^1.0.0:
     normalize-package-data "^2.3.2"
     path-type "^1.0.0"
 
+rechoir@^0.6.2:
+  version "0.6.2"
+  resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.6.2.tgz#85204b54dba82d5742e28c96756ef43af50e3384"
+  dependencies:
+    resolve "^1.1.6"
+
 redeyed@~1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/redeyed/-/redeyed-1.0.1.tgz#e96c193b40c0816b00aec842698e61185e55498a"
@@ -1814,7 +1837,7 @@ [email protected]:
   version "1.1.7"
   resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.1.7.tgz#203114d82ad2c5ed9e8e0411b3932875e889e97b"
 
-resolve@^1.2.0:
+resolve@^1.1.6, resolve@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.2.0.tgz#9589c3f2f6149d1417a40becc1663db6ec6bc26c"
 
@@ -1853,6 +1876,14 @@ set-blocking@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7"
 
+shelljs@^0.7.6:
+  version "0.7.6"
+  resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.7.6.tgz#379cccfb56b91c8601e4793356eb5382924de9ad"
+  dependencies:
+    glob "^7.0.0"
+    interpret "^1.0.0"
+    rechoir "^0.6.2"
+
 shellwords@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.0.tgz#66afd47b6a12932d9071cbfd98a52e785cd0ba14"