Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.23 KB

readme.md

File metadata and controls

55 lines (38 loc) · 2.23 KB

Requirements

For Windows, you will need:

Python 2.7.3 on PATH Git installed

Additionally, for Windows 7: Visual Studio 2010, at least Express Windows 7 x64 SDK for x64 systems

On Windows 8, try Microsoft Visual Studio C++ 2012 alone. If that doesn't work, you might need to add as well Microsoft Visual Studio C++ 2012

Installation

Requirements (see https://github.com/TooTallNate/node-gyp):

After cloning the repository, cd to the project root and run

$ npm install

Npm will then start loading the dependencies and configuration scripts will take care of manual dependency builds.

For development, grunt is configured to watch the file system and run mocha tests on changes, written in CoffeeScript, automatically. In order to start grunt, cd to the project root directory and type

$ grunt

This also enables jshint static code analysis and runs webpack once. Finally, the application is built via

$ node build

The build script will then generate the index.html main page with all scripts packed in a single JavaScript file.

Running

  1. You need a fatsecret API key. For security reasons it is included neither in the client JavaScript nor in the git repository. By default, a plain text file called signature is expected in the config subdirectory in the project root (i.e. yarse/config/signature with just one line of text). You may edit the location (yarse.signatureFile) in the project package.json file.
  2. If you put the key there, cd to the project root directory and start the signature server via node src/server.
  3. Open the index.html file you created before by running node build in your browser and enjoy the app.