dashboard icon indicating copy to clipboard operation
dashboard copied to clipboard

Interactive user interface for your data in ItemsAPI

Project is not maintained. To create your own search engine go to https://github.com/itemsapi/starter which is better and has more functionalities.

ItemsAPI dashboard

This project is an angular.js dashboard for ItemsAPI.

Initially it was mostly for demo purposes but now it allows you to:

  • create your own search api by providing json data
  • search and manage your items
  • integrate with heroku easily

Demo

  • http://app.itemsapi.com/

Requirement

  • node.js

Heroku installation

Deploy

Installation (ubuntu 14.04)

Node.js:

$ sudo apt-get install curl
$ curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
$ sudo apt-get install -y nodejs
$ sudo npm install [email protected] -g

Clone ItemsAPI Dashboard repository from github:

$ git clone https://github.com/itemsapi/dashboard.git
$ cd dashboard

local npm packages (in your project directory): it will install bower packages as well

$ npm install --production

Configuration and Run

Run with your Elasticsearch instance

$ PORT=3000 npm start

Run with your remote backend url (it automatically gets collections from http://cloud.itemsapi.com/api/v1/collections)

$ BACKEND_URL=http://cloud.itemsapi.com PORT=3000 npm start

Open http://localhost:3000 in your browser to check results

Example data

  • https://github.com/itemsapi/itemsapi-example-data/tree/master/items
  • https://raw.githubusercontent.com/itemsapi/itemsapi-example-data/master/items/restaurants.json

Troubleshooting

  • https://github.com/itemsapi/dashboard/blob/master/TROUBLESHOOTING.md

Contribution

This is early stage of the dashboard. There is still lot of works, improvements. If you want to help you can:

  • make code review and suggest improvements
  • share your ideas
  • add new pull requests

License

ItemsAPI dashboard is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.