This project is to display currency value, after converting one currency type to another.
To get you started you can simply clone the currency-converter
repository and install the dependencies:
You need git to clone the currency-converter
repository. You can get git from [here][git].
We also use a number of Node.js tools to initialize and test angular-seed
. You must have Node.js
and its package manager (npm) installed. You can get them from [here][node].
Clone the currency-converter
repository using git:
git clone https://github.com/asharma-ror/currency-converter.git
cd `currency-converter`
We have environment file at app/environemnt/env.js
to set FIXER_ACCESS_KEY
of fixer.io
app. Please update environment file with valid 'FIXER_ACCESS_KEY' before running e2e test cases.
We have two kinds of dependencies in this project: tools and AngularJS framework code. The tools help us manage and test the application.
- We get the tools we depend upon and the AngularJS code via
npm
, the [Node package manager][npm]. - In order to run the end-to-end tests, you will also need to have the [Java Development Kit (JDK)][jdk] installed on your machine. Check out the section on end-to-end testing for more info.
We have preconfigured npm
to automatically copy the downloaded AngularJS files to app/lib
so we
can simply do:
npm install
Behind the scenes this will also call npm run copy-libs
, which copies the AngularJS files and
other front end dependencies. After that, you should find out that you have two new directories in
your project.
node_modules
- contains the npm packages for the tools we needapp/lib
- contains the AngularJS framework files and other front end dependencies
Note copying the AngularJS files from node_modules
to app/lib
makes it easier to serve the
files by a web server.
We have preconfigured the project with a simple development web server. The simplest way to start this server is:
npm start
Now browse to the app at [localhost:8000/
][local-app-url].
There are two kinds of tests in the currency-converter
application: Unit tests and end-to-end tests.
The currency-converter
app comes preconfigured with unit tests. These are written in [Jasmine][jasmine],
which we run with the [Karma][karma] test runner. We provide a Karma configuration file to run them.
- The configuration is found at
karma.conf.js
. - The unit tests are found next to the code they are testing and have a
.spec.js
suffix (e.g.currency-converter.spec.js
).
The easiest way to run the unit tests is to use the supplied npm script:
npm test
This script will start the Karma test runner to execute the unit tests. Moreover, Karma will start watching the source and test files for changes and then re-run the tests whenever any of them changes. This is the recommended strategy; if your unit tests are being run every time you save a file then you receive instant feedback on any changes that break the expected code functionality.
You can also ask Karma to do a single run of the tests and then exit. This is useful if you want to check that a particular version of the code is operating as expected. The project contains a predefined script to do this:
npm run test-single-run
The currency-converter
app comes with end-to-end tests, again written in [Jasmine][jasmine]. These tests
are run with the [Protractor][protractor] End-to-End test runner. It uses native events and has
special features for AngularJS applications.
- The configuration is found at
e2e-tests/protractor-conf.js
. - The end-to-end tests are found in
e2e-tests/scenarios.js
.
Protractor simulates interaction with our web app and verifies that the application responds correctly. Therefore, our web server needs to be serving up the application, so that Protractor can interact with it.
Before starting Protractor, open a separate terminal window and run:
npm start
In addition, since Protractor is built upon WebDriver, we need to ensure that it is installed and
up-to-date. The currency-converter
project is configured to do this automatically before running the
end-to-end tests, so you don't need to worry about it. If you want to manually update the WebDriver,
you can run:
npm run update-webdriver
Once you have ensured that the development web server hosting our application is up and running, you can run the end-to-end tests using the supplied npm script:
npm run protractor
This script will execute the end-to-end tests against the application being hosted on the development server.