From 8db7454b9bb940608380536134d4aec29a4e1528 Mon Sep 17 00:00:00 2001
From: Arnau Casas <33383702+Casassarnau@users.noreply.github.com>
Date: Sat, 30 Oct 2021 11:51:33 +0200
Subject: [PATCH 1/2] fix typo

---
 challenge/templates/challenge_vote_reaction.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/challenge/templates/challenge_vote_reaction.html b/challenge/templates/challenge_vote_reaction.html
index 0bf0bf5..429740c 100644
--- a/challenge/templates/challenge_vote_reaction.html
+++ b/challenge/templates/challenge_vote_reaction.html
@@ -9,7 +9,7 @@
         </div>
     </div>
 
-    <h1 style="text-align: center">Thanks you {{ request.user.name }}!</h1>
+    <h1 style="text-align: center">Thank you {{ request.user.name }}!</h1>
     <div style="display:flex">
         <div style="margin: 0 auto; width: 50%">
             <img src="{{ reaction.image.url }}" width="100%">

From 9609b559f7115b6f9577a4e76685fc35e7c5a9ae Mon Sep 17 00:00:00 2001
From: Arnau Casas <33383702+Casassarnau@users.noreply.github.com>
Date: Sun, 31 Oct 2021 14:15:15 +0100
Subject: [PATCH 2/2] Readme

---
 readme.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..036b7f7
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,48 @@
+# The game
+
+## Set up
+Needs python 3.X and virtualenv
+
+- `Git clone https://github.com/hackupc/thegame.git && cd thegame`
+- `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`
+
+## Features
+
+- Admin page to create Challenges and more .
+- Auto HTML templating for Challenges (Image, template, File, Audio, Video, None).
+- MyHackUPC login (no passwords managed here).
+- Auto admin user for organizers.
+- Restriction on hacker submits (max X every 5 minutes).
+- Ranking page with local time.
+- Challenge stats and user attempts.
+- Codes encrypted.
+- Troll codes to redirect to urls with ChallengeTroll model.
+- Votes and comment for each challenge and custom reactions images with VoteReaction model.
+
+## Usage
+
+### Challenge
+
+- **name:** Challenge title
+- **description:** Challenge description (HTML format optional).
+- **order:** Challenge phase. User cannot see challenges if not completed all the challenges from previous phase (initial = 1).
+- **file:** Challenge file image, video, audio and HTML (django tags can be used).
+- **type:** Challenge type in order to render the file. If set to HTML, his url won't exist making it secret.
+- **solution:** Challenge solution. WriteOnly field. Encrypted.
+- **activation_date** Challenge activation date (UTC). Won't be accessible to hackers until this date.
+
+### ChallengeTroll
+
+- **challenge:** Challenge to add a troll code.
+- **code:** Code that will trigger the redirection.
+- **url:** Url to redirect if code was submitted.
+
+### VoteReaction
+
+- **challenge:** Challenge to add this reaction.
+- **type:** Reaction can be happy (vote>5) or sad (vote<=5).
+- **image:** Image to display when the hacker votes.