Giter Club home page Giter Club logo

telescope's Introduction

Telescope

Build Status CircleCI js-airbnb/prettier-style

A tool for tracking blogs in orbit around Seneca's open source involvement. We will be working on updating this software and adding key features that can be found below listed ad MVP features.

An initial discussion of the project is available in the Overview document. For contribution, the docs can be found here Contribution

Quick Setup Guide

Clone the source locally:

$ git clone https://github.com/Seneca-CDOT/telescope.git
$ cd telescope

Copy env.example to .env to create a new environment configuration. Replace default key values in .env with credentials.

Install project dependencies:

$ npm install

Test the app:

$ npm test

MVP Features

  • Written in one of node.js or Python, or a mix of the two if that makes sense
  • Able to parse and use the existing Planet Feed List format, especially RSS and Atom feeds
  • Static HTML generated from current feed posts, shown in chronological order
  • Logging, especially of errors or other issues when downloading and parsing feeds
  • Process should be automatic, running continually, restart itself if it crashes
  • Ability to send emails to admins, users when things go wrong or need attention
  • Everything is configurable. It should be easy for the admin(s) to turn features on and off via "feature flags." It should be easy to merge new features and flag them off until they are ready to be used.
  • Test harness and an initial set of tests
  • Use of CI/CD, running tests and doing automatic deploys
  • Running on Seneca's Kubernetes container cloud
  • Developer and User docs

Getting the project legacy code

You may want a copy of the legacy project for later reading.

To grab a local copy of the legacy project.. you can run wget.

To build the project for yourself you can follow the instructions in the INSTALL file.

Linux/Mac

wget -r --no-parent https://people.gnome.org/~jdub/bzr/planet/devel/trunk/

Windows

  1. Download wget binary here
  2. cd path/to/downloaded/wget
  3. wget -r --no-parent https://people.gnome.org/~jdub/bzr/planet/devel/trunk/

License

BSD ©

telescope's People

Contributors

humphd avatar manekenpix avatar manan311 avatar cheiaych avatar cindyledev avatar neilong31 avatar musabajwa avatar drwm-base avatar nazneennahar avatar eekbatani avatar miggs125 avatar s-arika avatar immutablevoid avatar ultimabgd avatar silvyre avatar shmooey avatar vitokhangnguyen avatar smilegodly avatar c3ho avatar odaving avatar brucremo avatar zufishanali avatar l1qu1dated avatar kartik-budhiraja avatar izhuravlev avatar karlachen avatar agarcia-caicedo avatar evlnyng avatar lozinska avatar ragnarokatz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.