hackassistant / registration

✏️ Hackathon registration server

📝 Hackathon registration server. Remake of the HackAssistant/registration in order to improve the future development and maintainability.

Features

• Email sign up ✉️
• Email verification 📨
• Forgot password 🤔
• Ip block on failed login tries & ip blocklist ✋ (Optional)
• Dark mode 🌚 🌝 Light mode (Optional)

Documentation

There's a really extended documentation for configurations or development of the application here.

Development

The development if this Django app can be made by Python or Docker-Compose. We recommend the use of Docker.

Docker-Compose

Needs: Docker, Docker-Compose

• ./install.sh (Creates virtualenviroment, install requirements.txt and migrates DB)
• docker-compose up (Starts server)

That is all! 😃 If you need to run any python command just do as the following examples:

• Install new library: docker-compose run python -m pip install [library]
• Make migrations: docker-compose run python manage.py makemigrations
• Migrate: docker-compose run python manage.py migrate

Python

Needs: Python 3.X, virtualenv

Stable at Python v.3.8.X and 3.10 (tested at Python 3.8.17 and 3.10)

• git clone [email protected]:HackAssistant/hackassistant.git && cd hackassistant
• virtualenv env --python=python3
• source ./env/bin/activate
• pip install -r requirements.txt
• python manage.py migrate
• python manage.py createadmin (creates admin to manage all the app: CUSTOM COMMAND!)
• python manage.py runserver localhost:8000 (specifies to localhost, since admin is created under that specific domain, otherwise it wont work)

registration's Issues

Add gmail actions compatibility

Invite email: https://developers.google.com/gmail/markup/reference/rsvp-action

Confirmation email: https://developers.google.com/gmail/markup/reference/event-reservation

Make sure application voted is the same that was being shown

Right now the application voted could be different from the one being shown. To fix this we should add application_id as a hidden field and retrieve application on post with this field.

Design screens to be more consistent

Screens are now plain bootstrap, they need to be personalized in order to get a better feeling of this being a HackUPC app. @hackupc/design

Fix order in next application to vote

Avoid counting skipped reviews/votes when selecting next application to be voted by user.

This is done so that if an application gets skipped, then it doesn't affect others reviewers.

Fix first_timer error

For some reason when mapping, some first timers appear as non-first timers. Weirdest thing ever: Some other do work. Typeform API messing it up?

Application confirmation view

Design confirmation view

Should include:

• Button to cancel application
• Clear message of thanks for confirming

Should do:

• Send email of confirmation to applicant
• Check states are correct before confirming
• Should extend base design and have consistency with cancel view

Add manage.py command to fetch applications from typeform

This way we can remove the view and we can set a cron to run this in a script periodically.

Create test set to test the app locally

It should be good to create a test set to try the app locally or a script to create test sets

Make login temporary

Slack error reporting

We would like to add error email reporting. Django has this nicely built-in so it's only a matter of configuration.

• Add error reporting config - Django docs
• Add sendgrid smtp email option
• Study option to set as Slack instead of email - https://github.com/lamby/django-slack
• Add manual email reports for non-intrusive error handlers (aka internal error such as sendgrid)

Also, we need manual reporting for some errors we rather keep internal:

• http://stackoverflow.com/questions/29392281/manually-trigger-django-email-error-report

Add button for sync in admin dashboard

Application cancellation view

Cancel view for applications that have been invited or that are already accepted

Should include:

• Clear message of the consecuences
  • User will not be able to attend any more
• Action confirmation screen (ask before cancelling)

Should do:

• Check status application is correct
• Check post request is from the same page (CSRF)
• Extend from base design
• Be design consistent with confirmation screen

Add auto reminder and cancel

Create command action that

• checks applications that have been invited 4 days ago and sends last reminder, telling them to answer or their application will be opened.
• if application reminded and 5 days old -> new state: Expired

An Expired application can be invited again. It can't be confirmed without the invite.

Add code climate for best practices

https://codeclimate.com

Manage email list from sendgrid

Whenever a user confirms -> Add him to the email list
Whenever a user cancels -> Remove him from the email list

Add slack auto-invite

• Invite users to new Slack when confirming.
• Check users to send new invites to Slack on command

Inspiration: https://github.com/giginet/django-slack-invitation

Add full documentation for zero start release

• Add documentation regarding Sendgrid templates
• Add documentation regarding Sendgrid lists
• Add documentation on user permissions
• Extract config on Application name
• Extract config on email template codes
• Extract config on Sendgrid lists
• Add documentation on how to create a new Typeform serializer

Add links to error 500 for reporting

Add email link or new issue link for people to report what they did when a 500 error showed up.

Add review applications view

Admin only view similar to vote view that allows to manually accept knowing the current votes that the application has.

• Ordering should be for votes and submission_dates.
• Actions: Accept, Skip, Reject
• Note that as skip is a possible action, there should be a parameter that saves how many applications have been skipped (or just remove skip).

Reason: Actual admin dashboard doesn't show a lot of information to admins, so this would be an option to review applications one by one (after they have been voted)

See who checks in

Add something that allows you, as a admin, to see who checks in every application.

Add option to re-send invitation after expiring

Add new feature to allow sending a new invitation e-mail after the invitation has been expired due to timing limitations.

Add vote next application

Add views for users in HackUPC team vote applications.

This votes should be stored to order applications and decided either which ones should be accepted and which ones should be rejected.

• Next application to vote should be the less globally voted (and older if equals) that the user hasn't yet voted
• One user can't vote an application twice
• If a user has voted all applications he should a get a cookie. Like a real one

Add automatic deployment

References:

• https://kjaer.io/travis/

Add hacker to travel reimbursement list if travel reimbursement

• Add new list "Travel reimbursement" in Sendgrid
• If hacker with travel reimbursement confirms add to list (as well as general list)

Decide domain and application external name

I was thinking on labeling it as My HackUPC wow such originality

Adapt to new admission protocol

Topic to be determined. Being discussed internally in Slack.

Sign up interface for hackers

Add interface for hackers to sign up

Command to add hackers with reimbursement to mail list

This substitutes #39.

Create a command to add to a mail list all hackers that have been assigned some travel reimbursement.

The mail list on SendGrid can be the already existing HackUPC W17 Travel Reimbursement.

Login protocol for non-admin users

Add login protocol for authentification of non-admin users. This should be considered to avoid giving staff permissions to users that we only want so they want to vote.

• Root page should redirect to this login
• Add profile page
• Add navbar with links to profile
• Admin login doesn't work - it requires user to be staff.
• Login should be for non-staff and staff included

Get stats about t-shirt sizes & diets

Add custom 500 error template

The current 500 error makes me cry.

UPC blocking emails

Conversation to keep track of how things go regarding UPC blocking emails.

Filter by under aged

Add a new filter option in "Invitations" to filter by hackers under aged (information already present in the application)

Under-aged
Yes
No

Add reminder admin action

As an admin we want to send a reminder if an application hasn't responded

• Add invite date to model
• Show days since in admin list -> maybe new admin interface for this?
• Add reminder template

References:

• http://stackoverflow.com/questions/2223375/multiple-modeladmins-views-for-same-model-in-django-admin

Add attendance views

We want our volunteers to check people in. In that way, we need to create new views so that we can check-in people without having to be admins.

• QR scanner view -> when QR detects a valid token redirect to check-in page
• Manual confirmed list view
  • Search by token or name or last name or email
  • Show results of search and link to check-in view
• Check-in view-> should have information about the hacker (minimal) so that volunteer can check that this person is the attendee. Big button to mark as attended.

Considerations:

• We will need to add a new permission to vote and a different one for check-in. There are some users that should be able to vote but not check-in and viceversa.
• Vote views now should require this new permission

References:

• Javascript QR code scanner: https://github.com/LazarSoft/jsqrcode

Add fields for application

• Add genre
• Add CV
• Change states to allow for users to exist even if uncomplete form
• Add invited_by field

Pre formatted descriptions

Desceiptions of applications often have a format which would be helpful if maintained (\n an such). I think that adding <pre> in description would improve the readability of some applications

Move send emails to server?

This is an open discussion. What would you think on adding email send to django + do it async.

Idea to do it: http://django-background-tasks.readthedocs.io/en/latest/#known-issues

Add application management

• Invite applications
• Accept applications
• Reject applications

All of this from admin interface ^

Allow edit email

Allow edit email on admin panel

Add extra admin modules

• Module with amount applications confirmed, invited, applied...
• Module with confirmed amount travel reimbursement and invited travel reimbursement.
• Module with tshirts confirmed (number and %)
• Module with tshirts invited (number and %)
• Module with Food restrictions confirmed (number and %)
• Module with Food restrictions invited (number and %)

Send Slack invites once confirmed

Add Slack invite once confirmed

Add events API endpoint

Merge this into this project:

https://github.com/casassg/hackupc-api-live

Ask email confirmation to hackers on sign up

Send email confirmation for hackers on sign up

Fix cancellation url at confirmation email

Cancellation button doesn't work properly. Needs to be formatted in SendGrid.

Check bounce emails

Some emails got an error when sending. Find a way to check email bounces and notify DIRECTORS for manual invite.

Add user management

That's actually easy as it's implemented for django admin already

Start admin dashboard

This is non-prioritary. will fill with a better description when I have time.

Fix server error on cancel

For some reason when cancelling the invite to HackUPC, SendGrid returns a 400 error when trying to delete the user from the HackUPC List. Check why is this happening.

Serialize all data from typeform

After a request to Typeform API, serialize all its data into the model