Merge branch 'main' into challenges-description

README.md

@@ -1,47 +1,34 @@
-# 42ctf
+# 42CTF
-CTF by 42 students
+
+[42CTF](https://www.42ctf.org) is a CTF platform created by School 42 students and open to anyone.
+
 
 ### Todo
 
-- [x] Password reset
+TODO has been migrated to [issues](https://gitea.42ctf.org/42CTF/website/issues) !  
-- [x] Access solved challenges
+And hopefully, it is not redirected anymore to `/dev/null`.
-- [x] "Intro" section
-- [x] Profile edition
-- [x] Resources page
-- [x] Flags counter
-- [x] Graphs on profile page
-- [ ] Refacto the discord bot with OAuth
-- [x] Platform translation
-    - [x] French
-    - [ ] Russian
-    - [x] Spanish
-    - [ ] Italian
-    - [x] German
-- [ ] OAuth 42
-    - [ ] 42 Network leaderboard
-- [ ] Possibility for users to propose solution to challenges
-- [ ] Badges/achievments on profile pages
-- [x] Dynamic scoring
 
-#### Event feature
+### How to contribute ?
 
-- [X] make scoreboard for events
+First, you need to contact a 42CTF admin to get an account on the 42CTF gitea.  
-- [X] make access mod for events :
+You can contact us on [discord](https://discord.gg/3KDvt6hbWW) or by [email](mailto:42ctf@protonmail.com).  
-    - [X] Sub button for public events
+You can also fill this [form](https://forms.42l.fr/apps/forms/bpmyGR37AR4yHGnC) and we'll contact you.  
-    - [X] Access by password
+Then, once you have a gitea account, you can fork this repository, do some stuff, and open a pull request.
-    - [X] Begin date for display challenges
+
-    - [X] Ending date for stop flag submission
+If you want to translate the platform, then have a look at the [wiki](https://gitea.42ctf.org/42CTF/website/wiki).
-    - [ ] Access by invite link
+
-- [X] Admin rights
+If you want to help with bot development, it has now its own [repository](https://gitea.42ctf.org/42CTF/bot)
-    - [X] Admin can access to events pages without password
+
-    - [X] Admin can subscribe to event without password
+### How to set up my dev environment ?
-- [X] process flag submission
+
-    - [X] increment user score in Scores model
+There is only one file missing on this repository for you to run the server: `local_settings.py`.  
-- [X] add filters for admin dashboard
+You should create one in the `src` directory, with the following content:
-- [X] add search in fields in admin dashboard
+```
-- [X] Smooth display of events listing
+DEBUG = True
-- [X] Event info page with background and noice display
+SECRET_KEY = 'what you want'
-- [x] Create teams for events
+```
-    - [x] Create/join team
+
-    - [x] Manage team: change password / leave team
+When you'll run `python manage.py migrate` then `python manage.py runserver`, an empty database will be automatically created.  
-- [ ] Dynamic scoring for events 
+The `local_settings.py` is in the `.gitignore` and should stay that way, so we don't accidentally overwrite the production file when we deploy.
+
+To obtain administrator rights you can run `python manage.py createsuperuser`.

requirements.txt

@@ -1,3 +1,3 @@
-Django
+Django==3.2.11
-requests
+requests==2.27.1
-authlib
+authlib==0.15.5