Skip to content
A webapp that instantly shows you your app's underperforming keywords in the App Store
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api
public
tests
views
.gitignore
Procfile
README.md
app.js
gulpfile.js
host.js
mandrill.js
model.js
package.json
screenshot.js

README.md

Crapwords

A webapp that instantly shows you your app's underperforming keywords in the App Store.

Getting Started

  1. Clone this repo.
  2. Run npm install
  3. run nodemon app.js in your terminal

Technologies used

Backend: Hapi.js, MongoDB

Frontend: jQuery, D3.js, Bootstrap

Tests:

This app uses QUnit for testing, and the tests are divided into two parts:

  1. Functional tests
  2. UI tests

The tests runs automatically and are displayed in the browser at the paths '/tests/tests.html' and '/tests/ui_tests.html'.

Explanation of structure

The functions have been laid out so the app completes each task in the correct order. Due to node's asynchronous nature we had to be careful that the app did not get ahead of itself at any stage and try and execute functions too early. After all the initial steps are completed (choosing device, app, keywords etc.) the user gets the opportunity to reveice their 'Keyword King Report' in their inbox. The flow for the email feature goes as follows:

User clicks the 'submit button' in their browser The 'save' function in model.js is invoked. This saves the payload into the database. Then the 'fetchId' function in model.js is called. This fishes out the ID that MongoDB automatically assigns its documents. Next, the 'takeScreenShot' function in screenshot.js is invoked. This makes use of the Webshot module and points it at a URL that is dynamically created using the mongoDB ID fetched from the database. It is on this unique URL that the report is generated. Once the screnshot of the report is done, we invoke the 'sendEmail' function in mandrill.js. This attaches the screenshot to the email and then sends it to the user's email address.

As you can see, if the tasks aren't completed in this exact order, the app would collapse into a useless heap.

You can’t perform that action at this time.