Files
CTFd/README.md
Andrew Meserole 81fe9c179f Fix Image Links in README (#288)
Latest PR moving around the theme files broke the image links in the README.
2017-06-18 11:51:12 -04:00

28 lines
1.2 KiB
Markdown

![](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/original/static/img/logo.png?raw=true)
====
[![Build Status](https://travis-ci.org/CTFd/CTFd.svg?branch=master)](https://travis-ci.org/CTFd/CTFd)
[![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/)
## What is CTFd?
CTFd is a Capture The Flag in a can. It's easy to customize with plugins and themes and has everything you need to run a jeopardy style CTF.
![CTFd is a CTF in a can.](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/original/static/img/scoreboard.png?raw=true)
## Install
1. `./prepare.sh` to install dependencies using apt.
2. Modify [CTFd/config.py](https://github.com/CTFd/CTFd/blob/master/CTFd/config.py) to your liking.
3. Use `python serve.py` in a terminal to drop into debug mode.
4. [Here](https://github.com/CTFd/CTFd/wiki/Deployment) are some deployment options
5. You can check out the [Getting Started](https://github.com/CTFd/CTFd/wiki/Getting-Started) guide for a breakdown of some of the features you need to get started.
## Live Demo
https://demo.ctfd.io/
## Reverse Engineering Module
https://reversing.ctfd.io/
## Credits
* Logo by [Laura Barbera](http://www.laurabb.com/)
* Theme by [Christopher Thompson](https://github.com/breadchris)