Skip to content
This repository has been archived by the owner on Jan 28, 2021. It is now read-only.
/ Module-News Public archive

Listen to latest news headlines based on your personal interests and add them to your read later list. Part of a collection of Open Source modules for the COBI.Bike system.

License

Notifications You must be signed in to change notification settings

cobi-bike/Module-News

Repository files navigation

News DevKit module for COBI.bike

FOSSA Status

The DevKit module "News" displays the latest news headlines, based on the personal interest and allows you to add them to your read later list. It's part of a collection of Open Source modules for the COBI.bike system.

COBI.bike News module

Quickstart: Interactive Demo

The quickest way to test the module via Glitch.com:

Open demo button

Glitch.com allows you to edit, host and fork Node.js applications for quick prototyping. Follow the installation step 2 to 3 and copy the environment variables to the: .env file on Glitch.com

Overview

This module utilizes Newsapi.org to poll the latest news from various news outlets. The Node.js backend acts as a Newsapi.org proxy and serves a static page to the client, which allows the user to switch between headlines, read its description and add it to his read-later list.

Installation and Setup

You can easily deploy the module on your own:

Step 1: Clone repository

Clone this repository and install Node.js dependencies with:

npm install

Step 2: Create a Newsapi.org account

This module relies on Newsapi.org to poll the latest news from various news outlets. Create an account and retrieve your api key.

Step 3: Set environment variables

Set the environment variable NEWSAPI_KEY with your credentials for newsapi.org

Step 4: Run Node.js server

The module is accessible under localhost:3000 after starting the Node.js server with:

NEWSAPI_KEY=... node server.js

The settings menu can be accessed with the ?state=edit suffix.

Optional: Install COBI.bike DevKit Simulator

Follow the instructions to install the COBI.bike Google Chrome Simulator and get familiar with the basics of module development on the COBI plattform.

Useful DevKit links

Contributing to this project

Anyone and everyone is welcome to contribute to this project, the DevKit Simulator and the DevKit UI Components. Please take a moment to review the guidelines for contributing.

Copyright © 2018 COBI.bike GmbH

License

FOSSA Status

About

Listen to latest news headlines based on your personal interests and add them to your read later list. Part of a collection of Open Source modules for the COBI.Bike system.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published