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
- Download or Open PyCharm by JetBrains
- Select new project from Git or click the Git dropdown and select clone
- On the Voting Booth github page select the green code button and copy the link
- Paste the link in the URL section on PyCharm
- Once everything is finished go to File->Settings->Project:ask-meagain->Python Interpreter
- 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
- Switch to the develop branch in the bottom right corner of PyCharm (if applicable)
- In the terminal window type "python manage.py runserver 8000"
- Click the link that appears in the terminal window
- 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