Code Monkey home page Code Monkey logo

dashboard's Introduction

dashboard

Django App for Whittier Scholars Program

about

The Whittier Scholars Program offers students an alternative curricular path for a liberal arts education at Whittier College. Each student designs their own course of study at Whittier College. This app is designed to help students manage their curricular path, and to help the Whittier Scholars Council to advise students in the program.

The app was previously branded as Poetfolio (Poets + Portfolio; the nickname for Whittier College students is "The Poets" and the mascot is Johnny Poet). While perhaps a clever name, it proved too confusing in practice and so the app has been rebranded as Dashboard. However, the codebase is filled with references to the old branding and those references are likely to persist.

The app is in active development.

setup

The requirements.txt file was created with pip freeze, so any new deployment can use pip install -r requirements.txt to install the dependencies to the appropriate virtual environment. In addition, a number of environment variables will need to be set. They are as follows:

  • POETFOLIO_SECRET_KEY - a randomly generated value for the SECRET_KEY used in poetfolio/settings.py
  • POETFOLIO_PRODUCTION - set to any truthy value to set DEBUG to False; if the variable does not exist, DEBUG is set to True
  • POETFOLIO_DB_NAME - Django MySQL database name; defaults to 'poetfolio_dev'
  • POETFOLIO_DB_USER - Django MySQL database user; defaults to 'poetfolio'
  • POETFOLIO_DB_PASSWORD - Django MySQL database password; defaults to 'devdevdev' so don't use that
  • POETFOLIO_STATIC - full path for STATIC_ROOT; defaults to '/home/{yourusername}/static'
  • POETFOLIO_MEDIA - full path for MEDIA_ROOT; defaults to '/home/{yourusername}/media'
  • POETFOLIO_EMAIL_HOST - URL string for SMTP email server; port hard coded to 587
  • POETFOLIO_EMAIL_USER - login for SMTP email server
  • POETFOLIO_EMAIL_PASSWORD - password for SMTP email server; it's suggested to use a unique app password if possible

Other variables in poetfolio/settings.py are hardcoded with values that make sense for Whittier College (like LANGUAGE_CODE = 'en-us' and TIME_ZONE = 'America/Los_Angeles', etc.).

Otherwise, see https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/

credits

A great deal of work on this project was done by two Whittier Scholars Program students: Aaron Dodds ('19) and Noah Wilson ('21).

dashboard's People

Contributors

nwilson2020 avatar kaddu720 avatar wck0 avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

ekiree

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.