Document App

Overview

This application

Display documents
Allow a user to open a file to see its contents
Sort by name/type/date
filter by searching

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.

Running the Application

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

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

Protractor is used for end-to-end (e2e) testing.

It requires a webserver that serves the application. See the Running the Application during Development section, above.

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.

Application Directory Layout

app/                     --> all the source code of the app (along with unit tests)
  bower_components/...   --> 3rd party JS/CSS libraries, including Angular and jQuery
  img/...                --> image files
  document-detail/...       --> files for the `documentDetail` module, including JS source code, HTML templates, specs
  document-list/...         --> files for the `documentList` module, including JS source code, HTML templates, specs
  documents/...             --> static JSON files with document data (used to fake a backend API)
  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`)

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