Lancaster-University/DEMOS2
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
This repository has been archived on 2022-08-01. You can view files and clone it, but cannot push or open issues or pull requests.
DEMOS2/README.md

63 lines
2.8 KiB
Markdown
Raw Normal View History

Initial commit of DEMOS2 with the upgraded 'Create Event' UI. However, there is no input validation currently
2018-06-12 12:31:38 +00:00
# DEMOS2
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
Prototype Django-based e-voting application, to demonstrate DEMOS2's client-side encryption e-voting.
Initial commit of DEMOS2 with the upgraded 'Create Event' UI. However, there is no input validation currently
2018-06-12 12:31:38 +00:00
The previous repository for DEMOS2 by Carey Williams can be found at: https://github.com/CareyJWilliams/DEMOS2
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
### Main Application Dependencies
Updated README to include details on dependency requirements. Updated Create Event page to disable the create button when the reCAPTCHA expires
2018-06-12 13:30:23 +00:00
Python: Version 2.7 (Anything higher than this will not currently work)
Python packages: Specified in 'requirements.txt' - PyCharm will detect these dependencies and offer installation
MySQL Server: Community Ed will do - initialised with legacy password authentication
New MySQL DB User: Default username and password specified in 'aullauthdemo/settings.py'
New MySQL DB: demos2 (also specified in 'aullauthdemo/settings.py') - make sure to set the charset to UTF8
Finally, with all the above dependencies in place, you can simply issue the following command to initialise the DB:
python manage.py migrate
'aullauthdemo/settings.py' specifies the Google reCAPTCHA site key and private key which will need changing when deployed
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
onto a new domain. There is also a DOMAIN setting within the file that needs updating during deployment as things
like email functionality depend on this setting for correct URL generation during event preparation etc.
Updated README to include details on dependency requirements. Updated Create Event page to disable the create button when the reCAPTCHA expires
2018-06-12 13:30:23 +00:00
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
Emails from the application are currently sent from the following email account which can be updated within the settings:
demos2.no.reply@gmail.com
### NodeJS Dependencies
The Node.js crypto server depends on the milagro-crypto-js and express modules. A package.json file can be found in the
Node/ directory with these dependency requirements and therefore from this folder you can run:
npm install
Once the dependencies have been installed, you can then run the node server as per the below instructions.
### Step 1: Running the Python app and creating a new user account
Updated README to include details on dependency requirements. Updated Create Event page to disable the create button when the reCAPTCHA expires
2018-06-12 13:30:23 +00:00
You can run the server with the following command:
python manage.py runserver
The application will then be available at:
127.0.0.1:8000
You can then click on 'Join' to create a new user account. Currently, a server error is thrown when you create a new
email account saying something like 'Too Many Attempts'. Rest assured that the account will have been created. Navigate
back to the home page and you should be able to log in. This will hopefully be fixed in a future version.
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
### Step 2: Running Celery
Celery is used to run tasks asynchronously and the DEMOS2 application can't run without this application. A bash script
called 'start_celery_worker.sh' is provided to make starting a worker as easy as possible:
./start_celery_worker.sh
### Step 3: Running the NodeJS Server
Updated README to include details on dependency requirements. Updated Create Event page to disable the create button when the reCAPTCHA expires
2018-06-12 13:30:23 +00:00
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
The NodeJS server exposes a lot of cryptographic operations that the application depends on throughout. To run the
server, issue the following command line request from the Node/ folder:
Updated README to include details on dependency requirements. Updated Create Event page to disable the create button when the reCAPTCHA expires
2018-06-12 13:30:23 +00:00
General housekeeping such as adding package.json for Node server, bash script for launching a celery worker and updating the readme to assist with launching the DEMOS2 app. Updated some models to include UI helper functions. Main work done is around event preparation - with a Celery worker running and the Node server, trustees are now emailed a link to prepare events. The event detail page has also had a bit of an overhaul to include additional information and to make it easier to use
2018-07-02 09:06:05 +00:00
node index.js
Reference in a new issue Copy permalink