Git Product home page Git Product logo

roadmap's Introduction

Roadmap App

This is a simple flask app to automatically read the roadmap spreadsheet from UpStride Google Docs and render a javascript-based timeline.

How it works

It reads the content of a specific Google Spreadsheet using gspread and uses pandas to process the data and generate the payload that is sent to the service for rendering.

Important: The user is supposed to create a json file that is going to act as the credentials for the service to access the Google SPreadsheet API. Follow the steps here to understand how to generate this file and share your spreadsheet with the Google service account corresponding to the json file.

Deploy

First, open the file constants.py to modify the variables USER_DATA (to control user access) and APIKEYPATH (path to the json file for authentication mentioned above).

It can be deployed by either of the following ways:

  • Run Python flask app
$ cd src/ && python run.py
  • Build the docker container and start the service
$ cd src/ && . docker.sh

Both ways listen for requests on localhost:8082 by default.

Customization

You can modify the listening PORT among other variables in the constants.py file.

User authentication is controlled by simple user:passwd hardcoded in the constants.py file. This approach has a very low level of security, and thus it is strongly advised to implement a better authentication method before deploying in production.

roadmap's People

Contributors

wilderlopes avatar

Watchers

James Cloos avatar  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.