Skip to main content

A wafer-thin Django library for running small conferences.

Project description

wafer

Travis CI build status Wafer documentation

A wafer-thin web application for running small conferences. Built using Django.

Licensed under the ISC License.

Documentation

Available on readthedocs.org.

Supported Django versions

Wafer supports Django 1.11 and Django 2.0.

Installation

  1. wafer can be installed either from pypi (pip install wafer) or from the github repository.

  2. If installing from github, pip install -r requirements.txt should install all the required python and django dependencies.

  3. Wafer uses npm to manage front-end dependencies

    • Make sure you have a recent version of Node.js installed that includes npm.
    • Run npm install to install all dependencies, which also copies them to wafer/static/vendor.
  4. Install the wafer applications manage.py migrate

  5. If you don’t have one yet, create a superuser with manage.py createsuperuser.

  6. Examine the settings.py file and create a localsettings.py file overriding the defaults as required.

    STATIC_FILES, WAFER_MENUS, MARKITUP_FILTER, WAFER_TALKS_OPEN, WAFER_REGISTRATION_OPEN and WAFER_PUBLIC_ATTENDEE_LIST will probably need to be overridden.

    If you add extensions to MARKITUP_FILTER, be sure to install the appropriate python packages as well.

  7. Log in and configure the Site:

    • The domain will be used as the base for e-mails sent during registration.
    • The name will be the conference’s name.
  8. Wafer uses the Django caching infrastructure in several places, so the cache table needs to be created using manage.py createcachetable.

  9. Create the default ‘Page Editors’ and ‘Talk Mentors’ groups using manage.py wafer_add_default_groups.

  10. Have a fun conference.

Installing Bootstrap

The default templates and css files require jquery and bootstrap to work.

wafer provides a bower.json file to simplify the installation process. This requires a working nodejs installation.

  1. Install bower npm install bower
  2. Use bower to install appropriate versions of bootstrap and jquery $(npm bin)/bower install
  3. Move files to the correct location manage.py collectstatic

Features

  • Support for adding and editing sponsors via Django admin.
  • Schedule can be created and updated via Django admin.
  • Pages for static content, news and so forth can be handled via Django admin.
    • Can be delegated to the ‘Page Editors’ group.
    • Pages can be updated via the web interface.
  • Talk submissions, review and acceptance.
  • Generate a static version of the site for archival.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wafer, version 0.7.7
Filename, size File type Python version Upload date Hashes
Filename, size wafer-0.7.7-py3-none-any.whl (213.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size wafer-0.7.7.tar.gz (161.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page