fedora-elections
is a web application written in Python and based on Flask.
It implements the Range Voting system.
This project was developed using Fedora Project requests but can be easily adapted to other projects. Fedora Elections is integrated with the Fedora Account System (FAS).
To work on the Fedora Elections web application, you will need to create a development environment to test your changes. This is simplified by using Vagrant, a powerful and useful tool for creating development environments on your workstation.
You can quickly start hacking on the Fedora Elections web application using the Vagrant setup included in the elections repo is super simple.
First, install Vagrant, the vagrant-libvirt
plugin, and the vagrant-sshfs
plugin from the official Fedora repos:
sudo dnf install vagrant vagrant-libvirt vagrant-sshfs
Now, from the main directory (the one with the Vagrantfile
in it), run the
vagrant up
command to provision your development environment:
vagrant up
When completed, you will be able to SSH into your development virtual machine
with vagrant ssh
and run the command to start the Fedora Elections server:
vagrant ssh [vagrant@localhost ~]$ pushd /vagrant/; ./runserver.py --host "0.0.0.0";
Once that is running, go to localhost:5005 in your browser to see your running Fedora Elections test instance.
Fedora Elections uses web fonts hosted in Fedora's infrastructure that might not work when hacking locally due to CORS restrictions. If you install the fonts yourself, the Fedora Elections website will look the same as it would when deployed to production.
You can install the fonts with this command.
sudo dnf install open-sans-fonts
The following steps will get the rest of the application running. Make sure to use your Vagrant development environment when following these steps.
Before launching fedora-elections, the following packages should be installed:
httpd
libxslt
python
python-backports-ssl_match_hostname
python-bunch
python-chardet
python-fedora
python-fedora-flask
python-flask
python-flask-sqlalchemy
python-flask-wtf
python-jinja2
python-kitchen
python-lxml
python-openid
python-ordereddict
python-ordereddict
python-setuptools
python-simplejson
python-six
python-sqlalchemy0.7
python-urllib3
python-wtforms
This project is hosted on Pagure. For convenience, a mirror is also hosted on GitHub.
You can obtain the code via:
git clone https://pagure.io/elections.git
Set up venv (replacing <base_path_for_venv>
and <venv_name>
):
pip install --user virtualenv tox mkvirtualenv <base_path_for_venv>/<venv_name> . <base_path_for_venv>/<venv_name>
Install requirements:
pip install -r requirements.txt
An example configuration file is provided here.
From root of project, run:
oidc-register https://iddev.fedorainfracloud.org/ http://localhost:5005
Run:
python createdb.py
Run:
cat > config <<EOL OIDC_ID_TOKEN_COOKIE_SECURE = False OIDC_REQUIRE_VERIFIED_EMAIL = False EOL
There are 2 ways to start the application:
This is useful for a quick development instance, when you don't have to worry about security yet. Do not run this in production. The server will start on http://127.0.0.1:5005.
./runserver.py -c config
Copy fedora-elections.conf
to your Apache conf.d directory:
sudo cp files/fedora-elections.conf /etc/httpd/conf.d/.
Next, place fedora-elections.wsgi
in /var/www
:
sudo cp files/fedora-elections.wsgi /var/www
Adjust the Apache configuration file to point to your web directory. Then,
adjust the .wsgi
file in /var/www
to point to the fedora_elections
directory.
Place the configuration file in /etc/fedora-elections/fedora-elections.cfg
and adjust it as you wish.
sudo mkdir -p /etc/fedora-elections/ sudo cp files/fedora-elections.cfg /etc/fedora-elections/
Now, restart Apache:
sudo systemctl restart httpd
fedora-elections uses tox
to simplify testing, and support testing across multiple environments.
Refer to earlier in this section on "How to launch Fedora Elections" in this document to get set up with tox
To run tests, simply run:
tox
As mentioned earlier, this project is primarily hosted on Pagure. There is a mirror on GitHub, but only for convenience. Pagure is the preferred platform for accepting contributions. To file an issue, RFE, or other ticket, you must use Pagure. See other issues already filed here.
If you are interested in working on this project, ask in #fedora-admin
on irc.freenode.net or say hello on the Fedora Infrastructure mailing list.
fedora-elections is licensed under the GPLv2.