https://github.com/cjsheets/node-image-search-abstraction

Provide an abstraction layer to an image search API
https://github.com/cjsheets/node-image-search-abstraction

Last synced: about 1 month ago
JSON representation

Provide an abstraction layer to an image search API

• Host: GitHub
• URL: https://github.com/cjsheets/node-image-search-abstraction
• Owner: cjsheets
• Created: 2016-11-14T23:27:10.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-19T06:01:13.000Z (almost 8 years ago)
• Last Synced: 2024-11-07T07:24:47.049Z (3 months ago)
• Language: TypeScript
• Homepage: https://gog-img-api.herokuapp.com/
• Size: 188 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Image Search Abstraction Layer

## Overview

This app creates an abstraction layer for Googles image search API. The client is built on Angular v2.x

and Typescript, with a backend supported by Node + MongoDB and hosted on Heroku.

A demo version of this app is deployed at: [https://gog-img-api.herokuapp.com/](https://gog-img-api.herokuapp.com/)

![](client/assets/img/app-screenshot.jpg?raw=true)

Part of the [FreeCodeCamp](https://www.freecodecamp.com/cjsheets) curriculum based on the following user stories:

* I can get the image URLs, alt text and page urls for a set of images relating to a given search string.

* I can paginate through the responses by adding a ?offset=2 parameter to the URL.

* I can get a list of the most recently submitted search strings.

### Version 2.0

This app underwent a major rewrite. Version 2 improvemetns includes: 

* Use of reactive forms 

* Added model constraints

* Stricter Typing

* Jasmine / Karma unit tests

* Jasmine / Karma integration tests

* Protractor e2e tests

## Install

Clone this repository and install npm dependencies:

```

git clone [email protected]:cjsheets/node-image-search-abstraction.git

cd node-image-search-abstraction

npm install

```

## Run

To run locally or deploy, first build the client with `ng build`, and start the backend:

```

npm run express-prod

```

Navigate to `http://localhost:3000`

## Dev

For client development, first create a `proxy.conf.json` to redirect client requests from the

webpack dev server to the backend:

```

{

  "/api": {

    "target": "http://localhost:3000",

    "secure": false

  }

}

```

Start the front end, back end, and linter simultaniously:

```

npm start

```

Navigate to `http://localhost:4200`

## Test

For client unit and integration tests run:

```

npm test

```

For server tests, run:

```

npm run test:node

```

For end-to-end tests, first either install protractor globally 

(`npm install -g protractor`) or install developer dependencies and source

the local npm packages (`export PATH=$(npm bin):$PATH`). Confirm by running 

`protractor --version`. 

Start the selenium (protractor) server with: `npm run pre:e2e`

Finally, run the tests:

```

```

## Technology Stack

This package contains:

| Front-End | Back-End |

| ------- | ------- |

| Angular v2.x | Node.js |

| Material | Express |

| HTML5/CSS | MongoDB |

| Webpack | Bluebird |

| Both | 

| ------- |

| Typescript |

| Jasmine/Karma | (testing)

| Protractor | (e2e testing)

### To-Do

* Flatten routers promise chain

* Handle concurrent addToLatest, parseApiResponse

* Re-introduce custom error handling

* Use bluebird for promises

### License

MIT License

[![Analytics](https://cjs-beacon.appspot.com/UA-10006093-3/github/cjsheets/node-image-search-abstraction?pixel)](https://github.com/cjsheets/node-image-search-abstraction)