m-ober / byceps

BYCEPS is a tool to prepare and operate a LAN party, both online on the Internet and locally as an intranet system, for both organizers and attendees. [Work in progress. Lots of things to come.]

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BYCEPS

BYCEPS is the Bring-Your-Computer Event Processing System.

It is a tool to prepare and operate a LAN party, both online on the Internet and locally as an intranet system, for both organizers and attendees.

The system incorporates both experience from more than 15 years of organizing LAN parties as well as concepts and source code developed for more than a decade.

Parties using BYCEPS:

  • Since 2014, BYCEPS is the foundation of the public website and local party intranet of the LANresort (300+ attendees) event series.
  • In 2016, LANresort Bostalsee was launched on BYCEPS.
  • In 2017, NorthCon (1,300+ attendees) was relaunched on BYCEPS.

Other sites using BYCEPS:

  • In 2019, the OrgaTalk community was launched using BYCEPS as a discussion board.
Copyright:2006-2020 Jochen Kupperschmidt
License:Modified BSD, see LICENSE for details.
Website:https://byceps.nwsnet.de/

Code Status

Build Status Scrutinizer Code Quality Code Climate

Installation

See docs/installation.rst.

Testing

In the activated virtual environment, install the development dependencies:

(venv)$ pip install -r requirements-development.txt

Run the tests:

(venv)$ pytest

Serving

To spin up a local server (only for development purposes!) on port 5000 with debugging middleware and in-browser code evaluation:

$ BYCEPS_CONFIG=../config/development_admin.py FLASK_ENV=development flask run

In a production environment, it is recommended to have the application served by uWSGI or Gunicorn.

It is furthermore recommended to run it locally behind nginx and have the latter both serve static files and provide SSL encryption.

Shell

The application shell is an interactive command line that gives access to BYCEPS' functionality as well as the persisted data.

(venv)$ BYCEPS_CONFIG=../config/development_admin.py FLASK_APP=app.py flask shell

Installation of an extra package makes the shell easier to use due to features like command history and auto-completion:

(venv)$ pip install flask-shell-ipython

About

BYCEPS is a tool to prepare and operate a LAN party, both online on the Internet and locally as an intranet system, for both organizers and attendees. [Work in progress. Lots of things to come.]

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Python 73.3%Language:HTML 23.5%Language:CSS 2.4%Language:JavaScript 0.6%Language:Dockerfile 0.1%