Skip to content

Commit cc79307

Browse files
committed
Refined README
1 parent 81a2c91 commit cc79307

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,38 @@
11
# Devtools CTF
22

3-
Get familiar with your browser by solving CTF only with your devtools
3+
## Overview
44

5-
** Supports all common browsers
5+
DevTools CTF is an educational web application that presents cybersecurity challenges solvable exclusively through browser developer tools.
66

7-
**Fuck IE don't even try!
7+
### Supported Browsers
88

9-
# Development
9+
- Chrome/Chromium
10+
- Firefox
11+
- Safari
12+
- Edge
1013

11-
Here is a quick guide to develop more levels
14+
> **Note**: Internet Explorer is not supported due to limited developer tools functionality.
15+
16+
### Usage (Docker Compose)
17+
18+
#### Docker
19+
20+
```bash
21+
docker build -t devtools-ctf .
22+
docker run -d -p 4000:8080 -e PORT=8080 devtools-ctf
23+
```
24+
25+
#### Docker Compose
1226

13-
## Creating A new Level
27+
```bash
28+
docker-compose up -d
29+
```
30+
31+
Access the application at `http://localhost:3000`
32+
33+
## Development
34+
35+
Here is a quick guide to develop more levels
1436

1537
### Create a new Page
1638

@@ -48,7 +70,7 @@ NOTE: don't copy-paste like an idiot, you might delete other levels by accident.
4870
### Create a new Controller
4971

5072
```bash
51-
$ nest g co myLevel controllers --flat
73+
nest g co myLevel controllers --flat
5274
```
5375

5476
This command will create a new `my-level.controller.ts` file inside `controllers/` directory. `--flat` means it will not
@@ -75,4 +97,3 @@ export class MyLevelController {
7597
```
7698

7799
to add more routes just learn `nestjs`, and put them inside the relevant controller.
78-

0 commit comments

Comments
 (0)