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

csweb-news

v0.0.2

Published

Wrapper around AlchemyNews API and OpenCalais API, to find and enhance news articles for based on keywords.

Downloads

6

Readme

csWeb-news

NPM package to get news articles based on certain keywords and save them as GeoJson-features, which provides the option to load them into csWeb.

It uses AlchemyNews for obtaining news items (based on keywords), and OpenCalais for converting news items into structured text, e.g. by adding additional information to news items (e.g. location). Both of these services require an API key, but do offer free services as well.

Usage

For example, if you want to create a folder with news items, do the following.

  • Download the zip file from csWeb-example and unpack it in a new folder.
  • Install all regular dependencies in this new project, install csweb-news package, and compile the source:
npm i
npm i csweb-news --s
cd public && bower i
cd ..
tsc -w -p .
  • Add the news service to your server.ts file. When starting the server (node server.js), you should see a message on the console upon loading the file.
cs.start(() => {
    var opts = { corrs: true,
          newsFolder: __directory + '/news',
          alchemyApi: config.alchemyFeedApiKey,
          calaisApi: config.openCalaisApiKey,
          keywords: config.keywords,
          updateInterval: config.updateIntervalSeconds
        };
    var ns = new csWebNews.NewsSource(cs.server, opts);
    console.log('started');
});
  • Request an API key for AlchemyNews and OpenCalais and paste them in the configuration.json file.
  • Place the topics that you are interested in, in the keywords parameter of the configuration.json. e.g.
    {"openCalaisApiKey" : "xxxxx",
    "alchemyFeedApiKey" : "xxxxx",
    "keywords" : ["Soccer", "Premier League"],
    "updateIntervalSeconds" : 900}
...

The news items will be put in the ./news folder. More information of how to put these features on the map, can be found here: csWeb-wiki.