Skip to content

Latest commit

 

History

History
74 lines (70 loc) · 2.69 KB

README.md

File metadata and controls

74 lines (70 loc) · 2.69 KB

Voting Booth

Last Updated: 1/17/2022

Introduction

Voting Booth is meant to be a mobile application that allows USG to survey the student population. The project makes use of Django which is a Python based web framework.

Development instructions currently under construction

Basic instructions:

  • Install Git
  • Install Python 3.8
  • Clone the repo
  • $ git checkout develop
  • $ pip install -r requirements.txt
  • $ cd votingbooth
  • $ python manage.py makemigrations
  • $ python manage.py migrate
  • $ python manage.py loaddata default
  • $ python manage.py runserver
  • http://localhost:8000

Legacy Instructions:

Setup: https://youtu.be/4Kgu8OnjrJw

  1. Download or Open PyCharm by JetBrains
  2. Select new project from Git or click the Git dropdown and select clone
  3. On the Voting Booth github page select the green code button and copy the link
  4. Paste the link in the URL section on PyCharm
  5. Once everything is finished go to File->Settings->Project:ask-meagain->Python Interpreter
  6. Add the following packages/libraries to the project:
    • Cython
    • Django <-- download first (v3.1.8)
    • PyJWT
    • asgiref
    • certifi
    • cffi
    • chardet
    • charset-normalizer
    • cryptography
    • defusedxml
    • django-social-auth
    • httplib2
    • idna
    • oauth2
    • oauthlib
    • pip
    • pycparser
    • pyparsing
    • python-openid
    • python3-openid
    • pytz
    • pyusb
    • requests
    • requests-oauthlib
    • setuptools
    • six
    • social-auth-app-django <-- download second
    • social-auth-core
    • sqlparse
    • urlib3
  7. Switch to the develop branch in the bottom right corner of PyCharm (if applicable)
  8. In the terminal window type "python manage.py runserver 8000"
  9. Click the link that appears in the terminal window

Other Notes

  • https://www.djangoproject.com/ is your best start place for learning how to do something in Django
  • Running makemigrations (see database_doc.md) should be tried early on when troubleshooting an unexpected issue