Update 'README.md'

This commit is contained in:
Danhia 2022-02-16 13:50:19 +01:00
parent e69a18922c
commit 8cada5b6d2
1 changed files with 27 additions and 42 deletions

View File

@ -1,47 +1,32 @@
# 42ctf
CTF by 42 students
# 42CTF
[42CTF](https://www.42ctf.org) is a CTF platform created by School 42 students and open to anyone.
### Todo
- [x] Password reset
- [x] Access solved challenges
- [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
TODO has been migrated to [issues](https://gitea.42ctf.org/42CTF/website/issues) !
And hopefully, it is not redirected anymore to `/dev/null`.
#### Event feature
### How to contribute ?
- [X] make scoreboard for events
- [X] make access mod for events :
- [X] Sub button for public events
- [X] Access by password
- [X] Begin date for display challenges
- [X] Ending date for stop flag submission
- [ ] Access by invite link
- [X] Admin rights
- [X] Admin can access to events pages without password
- [X] Admin can subscribe to event without password
- [X] process flag submission
- [X] increment user score in Scores model
- [X] add filters for admin dashboard
- [X] add search in fields in admin dashboard
- [X] Smooth display of events listing
- [X] Event info page with background and noice display
- [x] Create teams for events
- [x] Create/join team
- [x] Manage team: change password / leave team
- [ ] Dynamic scoring for events
First, you need to contact a 42CTF admin to get an account on the 42CTF gitea.
You can contact us on [discord](https://discord.gg/3KDvt6hbWW) or by [email](mailto:42ctf@protonmail.com).
You can also fill this [form](https://forms.42l.fr/apps/forms/bpmyGR37AR4yHGnC) and we'll contact you.
Then, once you have a gitea account, you can fork this repository, do some stuff, and open a pull request.
If you want to translate the platform, then have a look at the [wiki](https://gitea.42ctf.org/42CTF/website/wiki).
If you want to help with bot development, it has now its own [repository](https://gitea.42ctf.org/42CTF/bot)
### How to set up my dev environment ?
There is only one file missing on this repository for you to run the server: `local_settings.py`.
You should create one in the `src` directory, with the following content:
```
DEBUG = True
SECRET_KEY = 'what you want'
```
When you'll run `python manage.py runserver`, an empty database will be automatically created.
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.