Git Product home page Git Product logo

cs587-dashboard's Introduction

CS587 Github Dashboard

This is a GitHub dashboard made for our CS587 class

Both the Django web server and postgreSQL database are hosted on Render.com

The website is hosted live at cs587-dashboard.onrender.com

Deploying

The included docker file runs the webserver, however, the postgreSQL server has to be setup separately. If a database is not setup, repositories will not be cached.

The environment variables are as follows.

# Github OAuth App authentication
GITHUB_OAUTH_SECRET=********
GITHUB_OAUTH_CLIENT_ID=********

# Django secret key
SECRET_KEY=********

# Bypass authentication with a GitHub personal token (Defaults to OAuth app behavior, uncomment to use)
# CURRENT_TOKEN=********

# Invalidate repo cache after x seconds (uncomment to set, defaults to 1hr)
# CACHE_INVALIDATE=3600

# Setup connection info for the database (Uncomment to use)
# DB_ENGINE=postgresql
# DB_USERNAME=postgres
# DB_PASS=1234
# DB_HOST=127.0.0.1
# DB_PORT=5432
# DB_NAME=cs587_dashboard_db

# Alternatively, use a URL, example is shown (Uncomment to use)
# DB_URL=postgres://cs587_dashboard_db_user:*********@dpg-******-a.oregon-postgres.render.com/cs587_dashboard_db

If no environment variables are set, the app should run, but logging in will not work.

Running Locally

The app can be run locally using the following commands

pip install -r requirements.txt

py manage.py runserver_plus

Python 3.12 was used for this project

cs587-dashboard's People

Contributors

lehuman avatar

Watchers

 avatar

cs587-dashboard's Issues

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.