Quick Start

We suggest you follow the process of:

  1. Configuration
  2. Build Static Assets
  3. Run Application
  4. Run Celery

Your first minutes with the Boulder Python application must be used to set the application up for your environment. This documentation will help you understand how the application is constructed and generally, how it works.

The application requires Python 3.6.

Configuration

Warning

You must replace these configuration values or the application will not run!

The following configuration values must be replaced or have their corresponding environment variables updated. You can also opt to use a config file (see section coming soon).

Application
  • SITE_NAME (defaults to boulderpython.org)
  • SITE_ADMIN (defaults to hi@boulderpython.org)
  • SECRET_KEY (has default, but you should change this)
Database
  • SQLALCHEMY_DATABASE_URI (defaults to local Postgres Database)
Celery
  • CELERY_BROKER_URL (defaults to local RabbitMQ server)
  • CELERY_RESULT_BACKEND (defaults to local RabbitMQ server)
SendGrid
  • SENDGRID_API_KEY
  • SENDGRID_DEFAULT_FROM
Meetup
  • MEETUP_KEY
  • MEETUP_GROUP
MailChimp
  • MAILCHIMP_USERNAME
  • MAILCHIMP_API_KEY
  • MAILCHIMP_LIST_ID
Trello
  • TRELLO_API_KEY
  • TRELLO_API_SECRET
  • TRELLO_TOKEN
  • TRELLO_TOKEN_SECRET
  • TRELLO_ASSIGNEE
  • TRELLO_HOOK
  • TRELLO_BOARD
  • TRELLO_LISTS
  • TRELLO_LABELS

Build Static Assets

Install node dependencies then run gulp (you should already have gulp.js installed globally):

$ npm install
$ gulp

Running App

$ flask runserver

Running Celery

$ celery worker -A application.celery --loglevel=info