Skip to content

Commit 6e89efe

Browse files
committed
added some extra steps to the README to make some details clearer, based on samson's feedback
1 parent 81258e9 commit 6e89efe

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,73 @@
11
# cybergator
2+
23
CyberGator: A Dynamic Framework for Cyber Resilience Assessment
34

45
## Project Overview
6+
57
CyberGator is a cyber resilience assessment framework designed for dynamic risk evaluation, attack simulation, and adaptive defense strategy generation. It integrates Flask, Plotly Dash, Neo4j, PostgreSQL (via Supabase), and AI-driven simulations to model and improve system resilience against Advanced Persistent Threats (APTs).
68

79
---
10+
811
## Pre-requisites
12+
913
- **[Docker](https://www.docker.com/get-started)**
1014
- **[Docker Compose](https://docs.docker.com/compose/install/)**
1115
- **[Python >= 3.12](https://www.datacamp.com/blog/how-to-install-python)**
1216
- **[Poetry](https://python-poetry.org/docs/#installation)**
1317

1418
Verify installations:
15-
19+
1620
`docker --version`
1721

1822
`poetry --version`
1923

20-
---
24+
---
25+
2126
## Running the Application (Development)
2227

2328
1. Clone the Repository
29+
2430
```
25-
git clone https://github.com/your-org/cybergator.git
31+
git clone git@github.com:OzPol/cybergator.git
2632
cd cybergator
2733
```
2834

2935
2. Create your .env file
3036
Your .env file should be placed in the root of the project (same level as the Dockerfile)
3137

32-
2. Build the container
38+
3. Make sure your Docker desktop is running! :)
39+
40+
4. Build the container
3341

3442
```
3543
docker-compose build
3644
```
3745

38-
3. Run the container
46+
5. Run the container
3947

4048
```
4149
docker-compose up
4250
```
4351

44-
4. Check the homepage in the browser
52+
6. Check the homepage in the browser
4553

4654
```
4755
http://localhost:8000
4856
```
4957

50-
5. When you are done, you can stop the container
58+
7. When you are done, you can stop the container
5159

5260
```
5361
docker-compose down
5462
```
5563

5664
### Important Notes
65+
5766
- In general, you only need to rebuild the container when there are changes to dependencies.
5867
- It's recommended to install dependencies INSIDE the container to avoid issues. Your local `poetry.lock` and `pyproject.toml` files will be automatically updated :) You can find detailed instructions for this in the next section.
5968

6069
## How to add and install new depencies to the application
70+
6171
1. Run the container in detached mode:
6272

6373
```
@@ -81,4 +91,3 @@ docker-compose up --build
8191
```
8292
docker image prune -f
8393
```
84-

0 commit comments

Comments
 (0)