Merge branch 'dev' into main

Documentation/installation/docker.md

@@ -0,0 +1,39 @@
+# 🐳 Deploying with Docker (recommended)
+
+Deploy HackMe effortlessly with a pre-built Docker image from Docker Hub. The app relies on a PostgreSQL database running on port 5432, with the frontend and backend operating on ports 3000 and 3001, respectively.
+
+## Prerequisites
+
+⚠️ Ensure that Docker and Docker Compose are installed on your machine.
+
+## Steps
+
+1. **Download and Extract the ZIP File**
+    [Download ZIP](https://github.com/GuillaumeDorschner/HackMe/releases/download/docker-compose/hackme.zip)
+
+1. **Run Docker Compose**  
+    Navigate to the extracted `hackme` folder and run:
+    ```bash
+    cd hackme
+    docker-compose up
+    ```
+    **Note:** The command may also be `docker compose up` without the dash.
+
+2. Navigate to `localhost:3000` in your browser to view the platform
+
+3. Congratulations 🎉, you've successfully deployed HackMe using a Docker image from Docker Hub! Dive into the world of ethical hacking by starting --> [here](/Documentation/hack.md).
+    
+    </br>
+
+4. Stopping the Docker Containers
+
+    To stop and remove all running containers as defined in the `docker-compose.yml` file, execute:
+    ```bash
+    docker-compose down
+    ```
+
+---
+
+Embrace the excitement of ethical hacking with HackMe. Sharpen your skills and contribute to a safer digital landscape. Your journey to becoming a master ethical hacker starts now! 🌐✨
+
+Created with ❤️ by [ESILV](https://www.esilv.fr/) | [GitHub](https://github.com/GuillaumeDorschner) | [LinkedIn](https://www.linkedin.com/in/guillaume-dorschner/)

Documentation/installation/manual.md

@@ -0,0 +1,37 @@
+# Manual Installation
+Alternatively, you can manually set up HackMe by following these steps:
+
+## Prerequisites
+
+⚠️ Make sure node and postgres are installed on your machine:
+- [Node.js](https://nodejs.org/en/)
+- [Postgres](https://www.postgresql.org/download/)
+
+
+## Steps
+1. Clone the repository
+```bash
+git clone https://github.com/GuillaumeDorschner/HackMe.git
+cd HackMe
+```
+2. Run `npm install && npm run client-install` to install dependencies
+```bash
+npm install && npm run client-install
+```
+1. Run `npm run database` to setup the database
+```bash
+npm run database:init
+```
+1. Run `npm run dev` to start the development server
+```bash
+npm run dev
+```
+1. Navigate to `localhost:3000` in your browser to view the platform
+2. Congratulations 🎉, you've successfully deployed HackMe! Dive into the world of ethical hacking by starting --> [here](/Documentation/hack.md).
+
+
+---
+
+Embrace the excitement of ethical hacking with HackMe. Sharpen your skills and contribute to a safer digital landscape. Your journey to becoming a master ethical hacker starts now! 🌐✨
+
+Created with ❤️ by [ESILV](https://www.esilv.fr/) | [GitHub](https://github.com/GuillaumeDorschner) | [LinkedIn](https://www.linkedin.com/in/guillaume-dorschner/)

README.md

@@ -1,41 +1,23 @@
 # HackMe 🛡️
-HackME is an interactive web platform designed to offer a safe and legal environment for aspiring ethical hackers to hone their skills.
+
+HackMe is an interactive web platform designed to offer a safe and legal environment for aspiring ethical hackers to hone their skills.
 
 ## 🚀 Getting Started
 
-Begin your journey into ethical hacking by deploying HackMe. You have two easy options:
-
-### Using Docker Composer (Recommended)
-Using Docker Compose is the **easiest** way to deploy HackMe. For detailed instructions, see our [Docker Guide](Documentation/docker.md).
-
-### Manual Installation
-Alternatively, you can manually set up HackMe by following these steps:
-
-1. Clone the repository
-```bash
-git clone https://github.com/GuillaumeDorschner/HackMe.git
-cd HackMe
-```
-2. Run `npm install && npm run client-install` to install dependencies
-```bash
-npm install && npm run client-install
-```
-3. Run `npm run database:init` to setup the database
-```bash
-npm run database:init
-```
-4. Run `npm run dev` to start the development server
-```bash
-npm run dev
-```
-4. Navigate to `localhost` in your browser to view the platform
-5. Look at the documentation for hacking the platform [here](Documentation/hack.md)
-
-## Developer's Corner 🛠️
-
-- Install [Node.js](https://nodejs.org/en/)
-- install [postgres](https://www.postgresql.org/download/)
-
-Feel the rush of ethical hacking with HackMe, while sharpening your skills and contributing to a safer digital world. Your journey towards mastering the art of ethical hacking begins now! 🌐✨
+Begin your journey into ethical hacking by deploying HackMe through one of the following methods:
+
+- [Deploy with Docker](Documentation/installation/docker.md) [recommended]
+- [Manual Installation](Documentation/installation/manual.md)
+
+## 🛠️ Developer's Corner
+
+HackMe is built using the following technologies:
+
+- [Node.js](https://nodejs.org/en/)
+- [Postgres](https://www.postgresql.org/download/)
+
+Embark on your journey to master the art of ethical hacking with HackMe and contribute to a safer digital world. 🌐✨
+
+---
 
 Created with ❤️ by [ESILV](https://www.esilv.fr/) | [GitHub](https://github.com/GuillaumeDorschner) | [LinkedIn](https://www.linkedin.com/in/guillaume-dorschner/)