shanewwarren / visual-twitter-history

Introduction

Hapi-Plugins.com is a searchable database of Hapi.js plugins. It was made for the book Developing a hapi Edge by:

• Van Nguyen
• Daniel Bretoi
• Wyatt Preul
• Lloyd Benson

This application was built from the beginning as open-source. Go ahead: Fork it and make it better!

Topics

• Quick Start
• Options
• Troubleshooting
• License

Quick Start

git clone https://github.com/hapijs-edge/hapi-plugins.com.git
cd hapi-plugins.com
npm install
npm run start

Then, open your browser to http://localhost:8080 to view your local copy of the web application. The first time a query is searched, it will take a few seconds and subsequent re-searches will feel instantaneous after the cache is warmed up.

Options

Environment Variables

• PRODUCTION
  • The PRODUCTION=1 npm run start env variable will disable console output of route table and good runtime statistics.
• DEVELOPMENT
  • The DEVELOPMENT=1 npm run start env variable will disable the public mongodb database and attempt to connect to a local mongodb.

Config.json

• port
  • The port to run the web server (defaults to 8080).
• apiPort
  • DEPRECATED: The port to run the api server (defaults to 8088).
• database
  • mongodb
    • host
      • The mongodb host connection string (defaults to public mongodb).
    • username
      • The username with which to connect to the host.
    • password
      • The password with which to connect to the host.

Troubleshooting

The search results are always empty

If the search results are empty and you are using the public mongodb instance, most likely some troll deleted everything. To repopulate visit HOST + '/admin/plugins/populate/source' in your browser where HOST is how you normally connect to hapi-plugins (default is http://localhost:8080).

License

The ISC License

Copyright (c) 2015, Lloyd Benson, Daniel Bretoi, Van Nguyen, Wyatt Preul

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.