rethinkCV

Master is super messy right now... sorry. I just got to the first stable version so it will be cleaned soon

Overview

rethinkCV thinks of a resume as a dataset rather than information on a piece of paper. By doing so, one can use powerful data visualisation tools such as d3js to bring resumes to light, and extract the fine details that an employer may require. This tool is still under development

Installing Dependencies

The application relies upon various Node.js tools, such as [Bower][bower], [Karma][karma] and [Protractor][protractor]. You can install these by running:

npm install

This will also run Bower, which will download the Angular files needed for the current step of the tutorial.

Most of the scripts described below will run this automatically but it doesn't do any harm to run it whenever you like.

Running the Application during Development

Run npm start.
Navigate your browser to http://localhost:8000/ to see the application running.

Unit Testing

Start Karma with npm test.
A browser will start and connect to the Karma server. Chrome and Firefox are the default browsers, others can be captured by loading the same URL or by changing the karma.conf.js file.
Karma will sit and watch your application and test JavaScript files. To run or re-run tests just change any of your these files.

End-to-End Testing

Need to get back to this... sorry....

Serve the application with: npm start
In a separate terminal/command line window run the e2e tests: npm run protractor.
Protractor will execute the e2e test scripts against the web application itself. The project is set up to run the tests on Chrome directly. If you want to run against other browsers, you must modify the configuration at e2e-tests/protractor-conf.js.

Note: Under the hood, Protractor uses the [Selenium Standalone Server][selenium], which in turn requires the [Java Development Kit (JDK)][jdk] to be installed on your local machine. Check this by running java -version from the command line.

If JDK is not already installed, you can download it [here][jdk-download].

Application Directory Layout

TODO: Update

app/                     --> all the source code of the app (along with unit tests)
  bower_components/...   --> 3rd party JS/CSS libraries, including Angular and jQuery
  core/                  --> all the source code of the core module (stuff used throughout the app)
    checkmark/...        --> files for the `checkmark` filter, including JS source code, specs
    phone/...            --> files for the `core.phone` submodule, including JS source code, specs
    core.module.js       --> the core module
  img/...                --> image files
  experience-detail/...  --> files for the `experience` module, including JS source code, HTML templates, specs
  experience-list/...    --> files for the `experience` module, including JS source code, HTML templates, specs
  experience/...         --> static JSON files with job data (used to fake a backend API)
  app.animations.css     --> hooks for running CSS animations with `ngAnimate`
  app.animations.js      --> hooks for running JS animations with `ngAnimate`
  app.config.js          --> app-wide configuration of Angular services
  app.css                --> default stylesheet
  app.module.js          --> the main app module
  index.html             --> app layout file (the main HTML template file of the app)

e2e-tests/               --> config and source files for e2e tests
  protractor.conf.js     --> config file for running e2e tests with Protractor
  scenarios.js           --> e2e specs

node_modules/...         --> development tools (fetched using `npm`)

scripts/                 --> handy scripts
  private/...            --> private scripts used by the Angular Team to maintain this repo
  update-repo.sh         --> script for pulling down the latest version of this repo (!!! DELETES ALL CHANGES YOU HAVE MADE !!!)

bower.json               --> Bower specific metadata, including client-side dependencies
karma.conf.js            --> config file for running unit tests with Karma
package.json             --> Node.js specific metadata, including development tools dependencies