website/README.md

32 lines
1.4 KiB
Markdown

# 42CTF
[42CTF](https://www.42ctf.org) is a CTF platform created by School 42 students and open to anyone.
### Todo
TODO has been migrated to [issues](https://gitea.42ctf.org/42CTF/website/issues) !
And hopefully, it is not redirected anymore to `/dev/null`.
### How to contribute ?
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.