Skip to content

Commit 635121f

Browse files
author
eshaan7
committed
better docs
1 parent d22adb6 commit 635121f

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ A CTF framework(in flask) for HackTheBox style machines.
55
## Features
66

77
* Flask Blueprints
8+
* Flask-admin for Admin views and easy realtime management
89
* Easily deployable on Heroku.
910
* User Registration, account management, Forgot password
1011
* Hash submission (currently 2 hashes: user and root)
@@ -18,28 +19,43 @@ A CTF framework(in flask) for HackTheBox style machines.
1819
* `Python 3.7.3` or atleast `> 3.6`.
1920
* Packages: [`src/requirements.txt`](src/requirements.txt).
2021

22+
1. Git clone the repo and `cd ` into it
23+
2124
```bash
2225
$ git clone https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework
23-
$ cd RTB-CTF-Framework/src/
26+
$ cd RTB-CTF-Framework/
27+
```
28+
2. Create `virtual environment` to deal with dependencies and requirements.
29+
30+
```bash
2431
$ virtualenv -p /usr/bin/python3 venv
2532
$ source venv/bin/activate
33+
$ cd src/
34+
```
35+
36+
3. With `virtual environment` activated, install requirements, init db and run !
37+
38+
```python
2639
[venv]$ pip install -r requirements.txt
40+
[venv]$ python create_db.py # Only required on first run
2741
[venv]$ python run.py
2842
```
2943

3044
Using this as simple as anything. Just configure your CTF settings in [`config.py`](https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework/blob/master/src/FlaskRTBCTF/config.py).
3145

46+
> Note: DO NOT FORGET to change admin credentials from [create_db.py]((https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework/blob/master/src/create_db.py)
47+
3248
#### Creating database instance file
3349

34-
Locally or for docker,
50+
Locally or for docker/linux server,
3551

3652
```bash
3753
$ source venv/bin/activate
38-
$ python3 # open python interpreter
39-
>>> from FlaskRTBCTF import db, create_app
40-
>>> db.create_all(app=create_app())
54+
$ python src/create_db.py
4155
```
4256

57+
> Running this also creates an admin account by default,
58+
4359
For Heroku,
4460

4561
```bash
@@ -50,15 +66,15 @@ $ heroku run python
5066

5167
## To-do
5268

53-
- [ ] isAdmin column in User table and Admin views (priority)
69+
- [ ] db relationship between User and Score Tables
5470
- [ ] Support for more hashes
5571
- [ ] Testing Password reset functionality
5672
- [ ] Notifications
5773
- [ ] More info for `home.html`
5874
- [ ] Need to implement `account.html` (not a priority)
5975

6076
<hr/>
61-
77+
- [x] isAdmin column in User table and Admin views (priority)
6278
- [x] Use Flask Blueprinsts
6379
- [x] Finalize black theme?
6480
- [x] Error messages not appearing in `/submit`

0 commit comments

Comments
 (0)