Lancaster-University/DEMOS2
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Updated README

Browse source
This commit is contained in:
Rumperuu 2018-07-16 10:52:39 +01:00 committed by GitHub
parent 14e475cf3b
commit 2e61ca7b94
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
README.md
View file

@ -1,62 +1,78 @@
# DEMOS2 # DEMOS2
Prototype Django-based e-voting application, to demonstrate DEMOS2's client-side encryption e-voting. Prototype Django-based e-voting application, to demonstrate DEMOS2's client-side
encryption e-voting.
The previous repository for DEMOS2 by Carey Williams can be found at: https://github.com/CareyJWilliams/DEMOS2 The previous repository for DEMOS2 by Carey Williams can be found at:
https://github.com/CareyJWilliams/DEMOS2
## Setup
### Main Application Dependencies ### Main Application Dependencies
Python: Version 2.7 (Anything higher than this will not currently work) * 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 * 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 * MySQL Server: Community Edition (initialise with 'legacy password authentication')
New MySQL DB User: Default username and password specified in 'aullauthdemo/settings.py' * 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 * 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: ### Database setup
python manage.py migrate After installing the above dependencies, issue the following command to initialise the DB:
'aullauthdemo/settings.py' specifies the Google reCAPTCHA site key and private key which will need changing when deployed ```
onto a new domain. There is also a DOMAIN setting within the file that needs updating during deployment as things python manage.py migrate
like email functionality depend on this setting for correct URL generation during event preparation etc. ```
The first run will produce a `django.db.utils.IntegrityError: (1215, 'Cannot add foreign key constraint')` error. Issue the command a second time and it will complete successfully.
### Settings
`allauthdemo/settings.py` specifies the Google reCAPTCHA site key and private key, which will need changing when deployed 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.
Emails from the application are currently sent from the following email account which can be updated within the settings: Emails from the application are currently sent from the following email account which can be updated within the settings:
demos2.no.reply@gmail.com ```
demos2.no.reply@gmail.com
```
### NodeJS Dependencies ### 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 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:
Node/ directory with these dependency requirements and therefore from this folder you can run:
npm install ```
npm install
```
Once the dependencies have been installed, you can then run the node server as per the below instructions. Once the dependencies have been installed, you can then run the node server as per the below instructions.
## InstructionsRunning
### Step 1: Running the Python app and creating a new user account ### Step 1: Running the Python app and creating a new user account
You can run the server with the following command: You can run the server with the following command:
python manage.py runserver ```
python manage.py runserver
```
The application will then be available at: The application will then be available at `127.0.0.1:8000`.
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.
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.
### Step 2: Running Celery ### Step 2: Running Celery
Celery is used to run tasks asynchronously and the DEMOS2 application can't run without this application. A bash script 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:
called 'start_celery_worker.sh' is provided to make starting a worker as easy as possible:
./start_celery_worker.sh ```
./start_celery_worker.sh
```
### Step 3: Running the NodeJS Server ### Step 3: Running the Node.js Server
The NodeJS server exposes a lot of cryptographic operations that the application depends on throughout. To run the The Node.js 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:
server, issue the following command line request from the Node/ folder:
node index.js ```
node index.js
```