A wafer-thin Django library for running small conferences.
Project description
wafer
=====
|wafer-ci-badge| |wafer-docs-badge|
.. |wafer-ci-badge| image:: https://travis-ci.org/CTPUG/wafer.png?branch=master
:alt: Travis CI build status
:scale: 100%
:target: https://travis-ci.org/CTPUG/wafer
.. |wafer-docs-badge| image:: https://readthedocs.org/projects/wafer/badge/?version=latest
:alt: Wafer documentation
:scale: 100%
:target: http://wafer.readthedocs.org/
A wafer-thin web application for running small conferences. Built using Django.
Licensed under the `ISC License`_.
.. _ISC License: https://github.com/CTPUG/wafer/blob/master/LICENSE
Documentation
=============
Available on `readthedocs.org`_.
.. _readthedocs.org: http://wafer.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 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
=====
|wafer-ci-badge| |wafer-docs-badge|
.. |wafer-ci-badge| image:: https://travis-ci.org/CTPUG/wafer.png?branch=master
:alt: Travis CI build status
:scale: 100%
:target: https://travis-ci.org/CTPUG/wafer
.. |wafer-docs-badge| image:: https://readthedocs.org/projects/wafer/badge/?version=latest
:alt: Wafer documentation
:scale: 100%
:target: http://wafer.readthedocs.org/
A wafer-thin web application for running small conferences. Built using Django.
Licensed under the `ISC License`_.
.. _ISC License: https://github.com/CTPUG/wafer/blob/master/LICENSE
Documentation
=============
Available on `readthedocs.org`_.
.. _readthedocs.org: http://wafer.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 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
Release history Release notifications | RSS feed
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.7.0.tar.gz
(141.7 kB
view details)
Built Distributions
wafer-0.7.0-py3-none-any.whl
(188.4 kB
view details)
wafer-0.7.0-py2-none-any.whl
(191.3 kB
view details)
File details
Details for the file wafer-0.7.0.tar.gz.
File metadata
- Download URL: wafer-0.7.0.tar.gz
- Upload date:
- Size: 141.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 314317b99c489a13cfaac5a3426e74503748ca30964b1bb8276d8f55187de31f |
|
| MD5 | 9eef4b68dba1baa1fa640abf40eee89a |
|
| BLAKE2b-256 | f6e82a99db89356688deb699fad8c366e76d70084efae3b41e12595960ff6fb7 |
File details
Details for the file wafer-0.7.0-py3-none-any.whl.
File metadata
- Download URL: wafer-0.7.0-py3-none-any.whl
- Upload date:
- Size: 188.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 94067e5b4e5950e50452668094351fc01f5097f9e566ef711170751ed9d29737 |
|
| MD5 | 1e1b06d5c713c72e26eccb6c7ce22a77 |
|
| BLAKE2b-256 | 0469c83e7f817589d1ea43857989c3d7eb8c602048d99fbdb0190ced25c4444e |
File details
Details for the file wafer-0.7.0-py2-none-any.whl.
File metadata
- Download URL: wafer-0.7.0-py2-none-any.whl
- Upload date:
- Size: 191.3 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4d7685aaf25530ecb3286c42f66432d1f2753c22912c52af16d9349dc980578c |
|
| MD5 | fd1292fa1d22afd1d134fe4a28c86794 |
|
| BLAKE2b-256 | 3c308f2c5cf7f7be72c4d647b289b6312ae015927c2c819844243a1e9dc0d3ad |
