HackAssistant


Maintainability CircleCI

📝 Hackathon registration server. Originally HackUPC/backend. With collaboration from HackCU. Medium article. User Guide

Features

Demo: http://registration.gerard.space (updated from master automatically. Running on Heroku free dyno)

Setup

Needs: Python 3.X, virtualenv

Dummy data

Coming soon

Available enviroment variables

Server

Local environment

Heroku deploy

You can deploy this project into heroku for free. You will need to verify your account to use the scheduler for automatic application expirations emails. See "Use in your hackathon" for more details on using in your hackathon.

Deploy

Production environment

Inspired on this tutorial to understand and set it up as in our server.

Set up gunicorn service in Systemd

Needs: Systemd.

[Service] User=user Group=www-data WorkingDirectory=/home/user/project_folder ExecStart=/home/user/project_folder/server.sh >>/home/user/project_folder/out.log 2>>/home/user/project_folder/error.log

[Install] WantedBy=multi-user.target


- Replace `user` for your linux user.
- Replace `project_folder` by the name of the folder where the project is located
- Create and enable service: `sudo systemctl start backend && sudo systemctl enable backend`

#### Set up Postgres

Needs: PostgreSQL installed

- Enter PSQL console: `sudo -u postgres psql`
- Create database: `CREATE DATABASE backend;`
- Create user for database: `CREATE USER backenduser WITH PASSWORD 'password';` (make sure to include a strong password)
- Prepare user for Django

```sql
ALTER ROLE backenduser SET client_encoding TO 'utf8';
ALTER ROLE backenduser SET default_transaction_isolation TO 'read committed';
ALTER ROLE backenduser SET timezone TO 'UTC';

Other SQL engines may be used, we recommend PostgreSQL for it's robustness. To use other please check this documentation for more information on SQL engines in Django.

Automatic Dropbox backup

Hackers data is really important. To ensure that you don't lose any data we encourage you to set up automatic backups. One option that is free and reliable is using the PostgresSQLDropboxBackup script.

Find the script and usage instructions here

Set up Dropbox storage for uploaded files

This will need to be used for Heroku or some Docker deployments. File uploads sometimes don't work properly on containerized systems.

  1. Create a new Dropbox app
  2. Generate Access token here
  3. Set token as environment variable DROPBOX_OAUTH2_TOKEN

Set up MyMLH

MyMLH is a centralized login system used by MLH. It makes it easier for hackers to sign up for more events without re-entering their data every time around.

This integration allows hackers to have part of their application completed using their information from MLH.

As of the moment, MyMLH can only be used to sign up. This decision is due to the fact that MyMLH can have accounts with emails not verified. This can be a security concern as someone could create an account with someone else's email and it would totally invalidate our verification email system. In that direction the approach taken is to extract fields and use them for the application during the sign up process.

  1. Create a new MyMLH app.
  2. Add https://DOMAIN//user/callback/mlh/ as a Redirect URI. Replace DOMAIN for the domain used to deploy your system. Ex: http://registration.gerard.space/user/callback/mlh/.
  3. Set MLH_CLIENT_SECRET using the strings in Application ID and Secret fields, concatenated with a @. Ex: application_id@secret.

Note that to test locally you will need to add a line where DOMAIN is localhost:8000.

Set up nginx

Needs: Nginx

server {
    listen 80;
    listen [::]:80;

    server_name my.hackupc.com;

    location = /favicon.ico { access_log off; log_not_found off; }
    location /static/ {
        alias /home/user/project_folder/staticfiles/;
    }

    location /files/ {
        alias /home/user/project_folder/files/;
    }

    location / {
        include proxy_params;
        proxy_pass http://unix:/home/user/project_folder/backend.sock;
    }

}

Deploy new version

Management

Automated expiration

User roles

Important SQL queries

Here are several queries that may be useful during the hackathon application process.

  1. source ./env/bin/activate
  2. python manage.py dbshell
  3. Run SQL query
  4. Extract results

Missing applications emails

Emails from users that have registered but have not completed the application.

SELECT u.email
FROM user_user u
WHERE NOT is_director AND NOT is_volunteer AND NOT is_organizer
AND u.id NOT IN 
(SELECT a.user_id FROM applications_application a);

Use in your hackathon

You can use this for your own hackathon. How?

Personalization

Style

Content

Update emails:

You can update emails related to

Update hackathon variables

Check all available variables at app/hackathon_variables.py.template. You can set the ones that you prefer at app/hackathon_variables.py

Update registration form

You can change the form, titles, texts in applications/forms.py

Update application model

If you need extra labels for your hackathon, you can change the model and add your own fields.

Want to Contribute?

Read these guidelines carefully.

By making a contribution, in any form (including, but not limited to, Issues and Pull Requests), you agree to abide by the Code of Conduct. Report any incidents to report@gerard.space and appropriate action will be taken against the offender after investigation.

License

MIT © Hackers@UPC