Skip to content

reprohack/reprohack_site

Repository files navigation

Reprohack website

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Overview

The Reprohack app is built using django webapp framework.

Development and testing

The following are instructions for running the app on your local machine for testing or development.

Dependencies

The project uses a combination of python and javascript libraries. pip can be used to install all python related packages and node/npm can be used to install javascript packages.

Installation (using conda)

Use of conda is recommended as it is able to install all dependencies including nodejs. A minimal version of conda can be obtained from here.

Once conda is installed, the installation steps are as follows:

# Create a conda environment called 'reprohack'
conda create -n reprohack python=3.8

# Activate environment
source activate reprohack

# Install nodejs from conda-forge
conda install -c conda-forge nodejs

# Install python dependencies
pip install -r requirements/local.txt

# Install node dependencies
npm install

The conda environment must be activated every session

The conda environment must be re-activate after every session, e.g. when you open a new terminal. The following line of code must be run again to re-activate your conda environment:

source activate reprohack

Configuration (secret.py): IMPORTANT!

You must create a 'secret' python settings file for storing information that should not be public at:

config/settings/secret.py

The default values of these settings are located at config/settings/secret_default.py.

Sending E-mail

It's recommended to specify e-mail configurations inside the secrets.py settings file. As these settings will include username and passwords that should not be tracked by version control.

E-mail using SMTP

SMTP is supported as standard in Django, add the following configurations with your own details to the appropriate settings and secret.py settings file:

  1. In the appropriate settings file, e.g. config/settings/base.py set the EMAIL_BACKEND variable to gmailapi_backend.mail.GmailBackend:
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
  1. Ensure the EMAIL_HOST, EMAIL_PORT, EMAIL_HOST_USER, and EMAIL_HOST_PASSWORD is uncommented.

  2. Add the created credentials and tokens to the secret.py as shown below:

SECRET_EMAIL_HOST_USER = 'username'
SECRET_EMAIL_HOST_PASSWORD = 'password'
E-mail using Google API

The django-gmailapi-backend library has been added to allow sending of mail through Google's API as sending through SMTP is disabled as standard.

Unlike with SMTP, Google's API requires OAuth authentication which means a project and a credential has to be created through Google's cloud console.

This package includes the script linked in the documentation above, which simplifies the setup of the API credentials. The following outlines the key steps:

  1. Create a project in the Google developer console, https://console.cloud.google.com/
  2. Enable the Gmail API
  3. Create OAuth 2.0 credentials, you'll likely want to create a Desktop
  4. Create a valid refresh_token using the helper script included in the package:
gmail_oauth2 --generate_oauth2_token \
  --client_id="<client_id>" \
  --client_secret="<client_secret>" \
  --scope="https://www.googleapis.com/auth/gmail.send"
  1. In the appropriate settings file, e.g. config/settings/base.py set the EMAIL_BACKEND variable to gmailapi_backend.mail.GmailBackend:
EMAIL_BACKEND = 'gmailapi_backend.mail.GmailBackend'
  1. Add the created credentials and tokens to the secret.py as shown below:
SECRET_GMAIL_API_CLIENT_ID = 'your_google_assigned_id'
SECRET_GMAIL_API_CLIENT_SECRET = 'your_google_assigned_secret'
SECRET_GMAIL_API_REFRESH_TOKEN = 'your_google_assigned_token'

Authentication and E-mail verification

The site uses the allauth library to manage user authentication and email validation. The configuration can be found in config/settings.base.py under the section # django-allauth.

The ACCOUNT_EMAIL_VERIFICATION variable controls whether a user's e-mail needs to be verified, the options are none, optional or mandatory e.g.:

ACCOUNT_EMAIL_VERIFICATION = "mandatory"

See allauth's documentation for more details on other configuration variables.

Running the development server

Run the development server with the following command:

npm run serve

The app can then be accessed from http://127.0.0.1:8000. The app uses the config.settings.local config by default.

Running processes separately

The npm run serve runs two commands in parallel:

  • npm run serve:site - Runs the django's development serve`
  • npm run serve:assets - Monitors and builds javascript and scss assets with gulp

It may be useful to only run npm run serve:assets on its own while running the django app through an IDE of your choice for debugging.

Run npm run to see the full list of commands.

Creating normal users

To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Creating a superuser

To create an superuser account, use this command

python manage.py createsuperuser

Only the superuser is allowed to log into the admin panel (see next section).

Loading initial data

The command load_initial is created to load initial data. T he initial .csv files must be placed in the /initial_data folder with the name of events.csv, papers.csv and reviews.csv.

Ensure that the user to be assigned as the 'submitter/creator/reviewer' is created then use the command as follows:

./manage.py load_initial -submitter username

Admin panel

The admin panel can be access at /admin e.g. for the local development server http://127.0.0.1:8000/admin.

The panel can be used to browse and edit your database.

Changing the site name (Related to sent email templates)

The site name that's used in email templates can be changed in the admin panel.

  • Login to the admin panel /admin
  • In the left sidebar click on Sites
  • A newly initialised site will be named example.com, click on it, enter the new name and click save.

Testing

The pytest library is used for testing. Run the following command:

npm run test

Type checks

Is this useful? Running type checks with mypy:

mypy reprohack_hub

Test coverage

Is this useful? To run the tests, check your test coverage, and generate an HTML coverage report

coverage run -m pytest
coverage html
open htmlcov/index.html

Deployment: Pythonanywhere

The following are steps for deploying on python anywhere.

  • App setting is located at config/settings/pythonanywhere.py

Installation: Python anywhere

Instructions for installing a FRESH copy of the app on pythonanywhere.

On Pythonanywhere web GUI: Creating a web app

  • Log in to pythonanywhere
  • Go to the Web section
  • Click on Add a new web app
  • Select Manual app
  • On the web app configuration page, set:
    • Source code /home/reprohacks/reprohack_site
    • Working directory /home/reprohacks/reprohack_site
    • WSGI Configuraiton file, click on the link and set according to the next section
    • Virtualenv /home/reprohacks/reprohack_site/.virtualenv
    • Static files set URL as /static/ and directory /home/reprohacks/reprohack_site/
  • Set up the database by clicking on the Databases section
    • Press create database
    • You'll need to set a password
    • Create a database named reprohack

On Pythonanywhere web GUI: Setting up WSGI file for the webapp

import os
import sys

# add your project directory to the sys.path
project_home = '/home/reprohacks/reprohack_site'
if project_home not in sys.path:
    sys.path.insert(0, project_home)

# set environment variable to tell django where your settings.py is
os.environ['DJANGO_SETTINGS_MODULE'] = 'config.settings.pythonanywhere'


# serve django via WSGI
from django.core.wsgi import get_wsgi_application
application = get_wsgi_application()

Installing the app from github repository

Python anywhere already comes with Python 3.8 installed, so we can use virtualenv instead. Installation of node on the server is not as javascript dependencies are copied to django's static folder and is tracked through version control.

Access pythonanywhere's bash console or ssh into pythonanywhere, then run the following:

# Make sure we're in the home folder
cd ~

# Clone the app from the repository
git pull https://github.com/reprohack/reprohack_site.git

# Go into the folder
cd reprohack_site

# Create a virtual python environment using python 3.8
python -m virtualenv --python=/usr/bin/python3.8  .virtualenv

# Activate the virtual environment
source .virtualenv/bin/activate

# Install python dependencies
pip install -r requirements/production.txt

You will then need to create a secrets setting file at config/settings/secret.py, copy the contents of config/settings/secret_default.py and use that as the basis. Add the settings such as MYSQL_USERNAME, MYSQL_PASSWORD etc. to the secret.py.

Once all the above has been set up, we then need to update the database and ensure that static resources are gathered into the static folder:


# Build the database
./manage.py migrate

# Collect the static assets into /staticfiles folder
./manage.py collectstatic

Updating the app after installation

If the source code of the app has been updated, to make it reflect on the server, run the deploy.sh file which runs the following command:

# Activate the virtual environment
source .virtualenv/bin/activate

# Pull the update from git
git pull

# Make sure the databae is updated
./manage.py migrate

# Collect the static assets into /staticfiles folder
./manage.py collectstatic

CI/CD From Github

The CI script automatically deploys from github repository when pushed to dev or master branches (should be master only when) the site goes into production.

The deployment uses github secret variables to ssh into the pythonanywhere instance and call the deploy.sh script.

It might be necessary to go to the pythonanywhere dashboard and reload the app manually depending on the scope of the code changes.

Host Your Own

Note: When hosting the page on the internet, you will need to add the hostname to the Django settings. Edit mysite/settings.py by adding the hostname to ALLOWED_HOSTS list.


Please note that the 'reprohack_site' project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Creative Commons License
This work is licensed under a Creative Commons Attribution 3.0 Unported License.