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.8 and Django 1.9.

Installation

  1. pip install -r requirements.txt should install all the required python and django dependencies.

  2. Wafer uses bower to manage javascript dependencies

    • Install bower in the static files base directory: npm install bower

    • Grab the bower.json file to install the required javascript files

      ./node_modules/bower/bin/bower install bower.json

  3. Install the wafer applications manage.py migrate

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

  5. 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.

  6. 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.

  7. Wafer uses the Django caching infrastructure in several places, so the cache table needs to be created using manage.py createcachetable.

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

  9. 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 forthe can be handled via Django admin.

    • Can be delegated to the ‘Page Editors’ group.

    • Pages can be updated via the web interface.

  • Talk submissions and acceptance.

  • Generate a static version of the site for archival.

TODO

  • Make the code easier to use for other conferences (split out theming, etc).

  • Improve the talk submission management module:

    • Better display of accepted talks.

  • Make various messages easier to customise.

  • Improve admin support for the schedule:

    • Show table of slots in admin interface.

    • Improve handling of moving talks around.

  • Support for adding news (and other templated pages) via Django admin.

  • Maybe add some cool visualizations with d3:

    • Number of people signed up in various categories.

    • Places remaining.

    • Sponsorship slots remaining.

    • Days until various deadlines.

  • Other improvements

  • Add many tests

Project details


Download files

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

Source Distribution

wafer-0.4.5.tar.gz (118.8 kB view details)

Uploaded Source

Built Distributions

wafer-0.4.5-py3-none-any.whl (161.5 kB view details)

Uploaded Python 3

wafer-0.4.5-py2-none-any.whl (161.5 kB view details)

Uploaded Python 2

File details

Details for the file wafer-0.4.5.tar.gz.

File metadata

  • Download URL: wafer-0.4.5.tar.gz
  • Upload date:
  • Size: 118.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wafer-0.4.5.tar.gz
Algorithm Hash digest
SHA256 d21e75eb086d5597a936364293fb7da00a0e372a98b134ad2201129f6028681f
MD5 b78b93683c24fe786b3385d67cf8fb2f
BLAKE2b-256 d3a330765d78f022c3c28d9abeb827fc741eb182d95e44ad4da93acbebab2d4d

See more details on using hashes here.

File details

Details for the file wafer-0.4.5-py3-none-any.whl.

File metadata

File hashes

Hashes for wafer-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d2a3180f0060758ada082412b75c5a35df9dcbac81f54ad5d8e0fb146d2cccc3
MD5 e1e35d950d5bd6a18de023c65712083d
BLAKE2b-256 649451a5a91fcd3f2ebe647aa66af123ece33cc479011027f7f6a67bb94691c2

See more details on using hashes here.

File details

Details for the file wafer-0.4.5-py2-none-any.whl.

File metadata

File hashes

Hashes for wafer-0.4.5-py2-none-any.whl
Algorithm Hash digest
SHA256 0846cc61e0c9cde336bddef6fcdf723f2a34dafa76264336317154b324dab196
MD5 0cfa82ae623cb79b43b42f4ea22eb3cc
BLAKE2b-256 2320a7c72266d6f5235d734d4d556426cfae082ff397125fc88b3d5c25920e3d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page