npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ibm-watson/discovery-nodejs

v1.0.2

Published

Discovery sample application

Downloads

5

Readme

demo

Demo: https://discovery-news-demo.ng.bluemix.net/

Prerequisites

  1. Sign up for an IBM Cloud account.
  2. Download the IBM Cloud CLI.
  3. Create an instance of the Discovery service and get your credentials:
    • Go to the Discovery page in the IBM Cloud Catalog.
    • Log in to your IBM Cloud account.
    • Click Create.
    • Click Show to view the service credentials.
    • Copy the apikey value, or copy the username and password values if your service instance doesn't provide an apikey.
    • Copy the url value.

Configuring the application

  1. In the application folder, copy the .env.example file and create a file called .env

    cp .env.example .env
  2. Open the .env file and add the service credentials that you obtained in the previous step.

    Example .env file that configures the apikey and url for a Discovery service instance hosted in the US East region:

    DISCOVERY_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
    DISCOVERY_URL=https://gateway-wdc.watsonplatform.net/discovery/api
    • If your service instance uses username and password credentials, add the DISCOVERY_USERNAME and DISCOVERY_PASSWORD variables to the .env file.

    Example .env file that configures the username, password, and url for a Discovery service instance hosted in the Sydney region:

    DISCOVERY_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
    DISCOVERY_PASSWORD=A4Z5BdGENrwu8
    DISCOVERY_URL=https://gateway-syd.watsonplatform.net/discovery/api

Running locally

  1. Install the dependencies

    npm install
  2. Build the application

    npm run build
  3. Run the application

    npm start
  4. View the application in a browser at localhost:3000

Deploying to IBM Cloud as a Cloud Foundry Application

  1. Build the application

    npm run build
  2. Login to IBM Cloud with the IBM Cloud CLI

    ibmcloud login
  3. Target a Cloud Foundry organization and space.

    ibmcloud target --cf
  4. Edit the manifest.yml file. Change the name field to something unique. For example, - name: my-app-name.

  5. Deploy the application

    ibmcloud app push
  6. View the application online at the app URL, for example: https://my-app-name.mybluemix.net

Tests

Unit tests

Run unit tests with npm run test-unit, then a to run all tests. See the output for more info.

Integration tests

First you have to make sure your code is built: npm run build

Then run integration tests with: npm run test-integration-runner

Directory structure

.
├── app.js                      // express routes
├── config                      // express configuration
│   ├── error-handler.js
│   ├── express.js
│   └── security.js
├── package.json
├── public                      // static resources
├── server.js                   // entry point
├── test                        // integration tests
└── src                         // react client
    ├── __test__                // unit tests
    └── index.js                // app entry point

License

This sample code is licensed under the MIT License.

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page