Pivot is a web app for conducting Ranked Pairs elections. It is currently available for public testing on pivot.vote. The web app uses the Tideman library to compute election results.
Everything is licensed under the Apache 2.0 License with the exception of black-threads-light.png which is licensed from Toptal under CC BY-SA 3.0.
Before you start make sure you're running PHP >= 7.1 and have Composer installed.
composer install # Install PHP dependencies
cp .env.example .env # Create .env config file
vim .env # Update database credentials, add email service info
php artisan key:generate # Create application key
php artisan migrate # Run database migrations
php artisan passport:install # Create Oauth2 TokensThe project has two ways of executing tests.
PHPUnit tests can be executed simply by running phpunit on the command line at the root of the repository.
Some integration tests are written in Python. The python test script accepts some parameters. The most important one is --url - a url pointing to the root of a running Pivot app. If no value is specified, a default local homestead url is assumed.
The python test script reads from tests/python/users.json. users.json is not present by default. The following code example generates a users.json for you. Later optional instructions will tell you how to create one from scratch.
Example:
#Seed database with test data, create example users.json
php artisan db:seed --class=TravisSeeder
#Install Python dependencies
pip install -r requirements.txt
#Run the Python integration tests
cd tests/python
python tests.py --url http://pivot.testYou can optionally customize tests/python/users.json if you want the python tests to use something other than the automatically-generated accounts. users.json needs two users. You can register custom users in the Pivot web UI, log in to their /profile pages, (Ex: http://pivot.test/profile, create personal access tokens for them, and then copy the tokens and emails into the json file.
If you're going to be working in Sass or Vue.js you'll also need to have Node.js installed to use Laravel Mix
npm install # Install Node.js dependencies
npm run dev # Run all mix tasks# Run the database migrations
php artisan migrate
# Rollback all database migrations
php artisan migrate:reset
# Reset and re-run all migrations
php artisan migrate:refresh
# Recreate Oauth2 Tokens if you've wiped out the tables
php artisan passport:installOnce you have pivot up and running, visit http://yourhostname.here/docs in a web browser to view dynamic Swagger REST API documentation.