70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
# Wipro OpenWeatherMap App
|
|
|
|
|
|
## Intro
|
|
|
|
An application written in Javascript, utilising Backbone on the front end and Express on the back end.
|
|
|
|
The application is a single HTML page displaying the 5 day weather forecast for a location of my choice. In this case it is [Glasgow City](http://nurl.co/QD).
|
|
|
|
A live version of the application can be viewed at: [http://wiprotest-dev.eu-west-1.elasticbeanstalk.com](http://wiprotest-dev.eu-west-1.elasticbeanstalk.com)
|
|
|
|
## Installation
|
|
|
|
To install this application, it should be cloned from the repo:
|
|
|
|
```
|
|
|
|
git clone https://github.com/martind2000/wiprotest.git
|
|
|
|
```
|
|
|
|
Once the code has been retrieved you have to install the node packages:
|
|
|
|
```
|
|
|
|
npm install
|
|
|
|
```
|
|
|
|
This will install and build the app.
|
|
|
|
## How to use
|
|
|
|
Once the node packages have been installed the application is almost ready to run.
|
|
|
|
An OpenWeatherMap API key is required, if you do not already have one, then you can get one for free by going to this address: [http://openweathermap.org/appid](http://openweathermap.org/appid)
|
|
|
|
Once an APPID key has been obtained the application can be run by using the following
|
|
|
|
```
|
|
|
|
openweatherAPI=<APPID> npm start
|
|
|
|
```
|
|
|
|
replace \<APPID\> with your appid, such as:
|
|
|
|
```
|
|
|
|
openweatherAPI=b1b15e88fa797225412429c1 npm start
|
|
|
|
```
|
|
|
|
## Test
|
|
|
|
This application is currently tested using Mocha and Expect.js. The test is in the /test folder.
|
|
|
|
To run the test, run the following command.
|
|
|
|
```
|
|
|
|
npm test
|
|
|
|
```
|
|
|
|
## Todo
|
|
|
|
* Enhance the build process to merge the font and weather icon css, the Material UI css and the colour css into one file to reduce the number of server requests from 3 to 1.
|
|
* Better testing. Currently the tests are simple for brevity, however I would like to implement Browser testing to ensure the view portion of the code is working as intended.
|