Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/HackAssistant/registration

✏️ Hackathon registration server
https://github.com/HackAssistant/registration

django hackathon hackathon-registration-server hacktoberfest postgres registration sendgrid slack

Last synced: 11 days ago
JSON representation

✏️ Hackathon registration server

Awesome Lists containing this project

README 

        





  HackAssistant







[![Maintainability](https://api.codeclimate.com/v1/badges/dcf8e46541dbab5eb64f/maintainability)](https://codeclimate.com/github/HackAssistant/registration/maintainability)

[![CircleCI](https://circleci.com/gh/HackAssistant/registration/tree/master.svg?style=svg)](https://circleci.com/gh/HackAssistant/registration/tree/master)



📝 Hackathon registration server. Originally [HackUPC/backend](https://github.com/hackupc). With collaboration from [HackCU](https://github.com/hackcu). [Medium article](https://medium.com/hackcu/hackassistant-95d0f15c9199). [User Guide](USER_GUIDE.md)



## Features



- Email sign up ✉️

- Travel reimbursement management 💰

- Hackathon registration form 📝

- Check-in interface with QR scanner 📱

- Review applications interface for organizers (includes vote) ⚖️

- Email verification 📨

- Forgot password 🤔

- Automatic progress save on draft applications ⚙️

- Internal user role management: Hacker, Organizer, Volunteer, Director and Admin ☕️

- Automatic control of confirmation, expiration and cancellation flows 🔄

- Django Admin dashboard to manually edit applications, reimbursement and users 👓

- Flexible email backend (SendGrid is the default and recommended supported backend) 📮

- (Optional) Separate applications from dubious hackers to manually contact them 🧐

- (Optional) Automated slack invites on confirm #️⃣

- (Optional) MyMLH sign up 📥



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



## Setup



Needs: Python 3.X, virtualenv



- `git clone https://github.com/hackassistant/registration && cd registration`

- `virtualenv env --python=python3`

- `source ./env/bin/activate`

- `pip install -r requirements.txt`

- (Optional) If using Postgres, set up the necessary environment variables for its usage before this step

- `python manage.py migrate`

- `python manage.py createsuperuser` (creates super user to manage all the app)



### Dummy data



_Coming soon_



## Available enviroment variables



- **SG_KEY**: SendGrid API Key. Mandatory if you want to use SendGrid as your email backend. You can manage them [here](https://app.sendgrid.com/settings/api_keys).  Note that if you don't add it the system will write all emails in the filesystem for preview.

You can replace the email backend easily. See more [here](https://djangopackages.org/grids/g/email/).

- **PROD_MODE**(optional): Disables Django debug mode. 

- **SECRET**(optional): Sets web application secret. You can generate a random secret with python running: `os.urandom(24)`

- **DATABASE_URL**(optional): URL to connect to the database. If not sets, defaults to django default SQLite database. See schema for different databases [here](https://github.com/kennethreitz/dj-database-url#url-schema).

- **DATABASE_SECURE**(optional): Whether or not to use SSL to connect to the database. Defaults to `true`.

- **DOMAIN**(optional): Domain where app will be running. Default: localhost:8000

- **SL_TOKEN**(optional): Slack token to invite hackers automatically on confirmation. You can obtain it [here](https://api.slack.com/custom-integrations/legacy-tokens)

- **SL_TEAM**(optional): Slack team name (xxx on xxx.slack.com)

- **DROPBOX_OAUTH2_TOKEN**(optional): Enables Dropbox as file upload server instead of local computer. (See "Set up Dropbox storage for uploaded files" below)

- **MLH_CLIENT_SECRET**(optional): Enables MyMLH as a sign up option. Format is `client_id@client_secret` (See "Set up MyMLH" below)



## Server



### Local environment



- Set up (see above)

- `python manage.py runserver`

- Sit back, relax and enjoy. That's it!



### 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](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)



- Create super user by running `python manage.py createsuperuser` once the heroku app is deployed

- Add scheduler addon: https://elements.heroku.com/addons/scheduler

- Open scheduler dashboard: https://scheduler.heroku.com/dashboard (make sure it opens the just created heroku app)

- Add daily job `python manage.py expire_applications && python manage.py expire_reimbursements`



### Production environment



Inspired on this [tutorial](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-16-04) to understand and set it up as in our server.



- Set up (see above)

- Create server.sh from template: `cp server.sh.template server.sh`

- `chmod +x server.sh`

- Edit variables to match your environment and add extra if required (see environment variables available above)

- Create restart.sh from template: `cp restart.sh.template restart.sh`

- `chmod +x restart.sh`

- Edit variables to match your environment and add extra if required (see environment variables available above)

- Run `restart.sh`. This will update the database, dependecies and static files.

- Set up Systemd (read next section)



#### Set up gunicorn service in Systemd

Needs: Systemd.



- Edit this file `/etc/systemd/system/backend.service`

- Add this content

```

[Unit]

Description=backend daemon

After=network.target



[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';

```



- Grant all priviledges to your user for the created database: `GRANT ALL PRIVILEGES ON DATABASE myproject TO myprojectuser;`

- Exit PSQL console: `\q`



Other SQL engines may be used, we recommend PostgreSQL for it's robustness. To use other please check [this documentation](https://docs.djangoproject.com/en/1.11/ref/databases/) 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](https://github.com/casassg/PostgreSQL-Dropbox-Backup)



#### 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](https://www.dropbox.com/developers/apps)

2. Generate Access token [here](https://blogs.dropbox.com/developers/2014/05/generate-an-access-token-for-your-own-account/)

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](https://my.mlh.io/oauth/applications/new).

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



- `sudo vim /etc/nginx/sites-available/default`

- Add site:



```

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



- `git pull`

- `./restart.sh`

- `sudo service backend restart`



## Management



### Automated expiration



- Create management.sh from template: `cp management.sh.template management.sh`

- `chmod +x management.sh`

- Edit variables to match your environment and add extra if required (see environment variables available above)

- Add to crontab: `crontab -e`

```

*/5 * * * * cd /home/user/project_folder/ && ./management.sh > /home/user/project_folder/management.log 2> /home/user/project_folder/management_err.log

```



### User roles



- **is_volunteer_accepted**: Allows user to check-in hackers with QR and list view

- **is_organizer**: Allows user to vote, see voting ranking and check-in hackers.

- **is_director**: Allows user to send invites to hackers as well as send reimbursement. Also can review dubious applications.

- **is_admin**: Allows user to enter Django Admin interface

- **can_review_dubious**: User can review and mark as safe applications that seem weird.

- **can_review_blacklist**: User can review and mark as blacklist applications that their user seem to be in the blacklist.



### 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.



```sql

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?



- Fork this repo

- Update [app/hackathon_variables.py](app/hackathon_variables.py)

- Get SendGrid API Key (Sign up to [GitHub Student Pack](https://education.github.com/pack) to get 15K mails a months for being an student)

- Deploy into your server or in Heroku (see above)!



## Personalization



### Style



- Colors and presentation: [app/static/css/main.css](app/static/css/main.css).

- Navbar & content/disposition: [app/templates/base.html](app/templates/base.html)

- Email base template: [app/templates/base_email.html](app/templates/base_email.html)



### Content



#### Update emails:



You can update emails related to 

- Applications (application invite, event ticket, last reminder) at [applications/templates/mails/](applications/templates/mails/)

- Reimbursements (reimbursement email, reject receipt) at [reimbursement/templates/mails/](reimbursement/templates/mails/)

- User registration (email verification, password reset) at [reimbursement/templates/mails/](reimbursement/templates/mails/)



#### Update hackathon variables

Check all available variables at [app/hackathon_variables.py.template](app/hackathon_variables.py.template). 

You can set the ones that you prefer at [app/hackathon_variables.py](app/hackathon_variables.py)



#### Update registration form

You can change the form, titles, texts in [applications/forms.py](applications/forms.py)



#### Update application model

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



   - Update model with specific fields: [applications/models.py](applications/models.py)

   - `python manage.py makemigrations`

   - `python manage.py migrate`



# Want to Contribute?

Read these [guidelines](.github/CONTRIBUTING.md) 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](.github/CODE_OF_CONDUCT.md). Report any incidents to [email protected] and appropriate action will be taken against the offender after investigation.



# License



MIT © Hackers@UPC