Skip to content

BYCEPS is a tool to prepare and operate LAN parties (even under different brands), 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

xvzf/byceps

 
 

Repository files navigation

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.

Since 2014 BYCEPS is the foundation of the public website and local party intranet of the LANresort event series.

In 2016 and 2017, respectively, LANresort Bostalsee and NorthCon have been (re-)launched on BYCEPS.

Copyright

2006-2018 Jochen Kupperschmidt

License

Modified BSD, see LICENSE for details.

Website

http://homework.nwsnet.de/releases/b1ce/#byceps

Installation

See docs/installation.rst.

Testing

In the activated virtual environment, install tox and pytest:

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

Have tox run the tests:

(venv)$ tox

If run for the first time, tox will first create virtual environments for the Python versions specified in tox.ini.

Serving

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

$ BYCEPS_CONFIG=../config/development_admin.py ./manage.py runserver -p 8080

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 LAN parties (even under different brands), both online on the Internet and locally as an intranet system, for both organizers and attendees. [Work in progress. Lots of things to come.]

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 70.0%
  • HTML 25.9%
  • CSS 3.4%
  • JavaScript 0.7%