From c0eaffeffff9d3f061667a3dbd97ab85585eda70 Mon Sep 17 00:00:00 2001
From: Carter Perez <cartertechsolution@gmail.com>
Date: Tue, 9 Dec 2025 07:33:00 -0500
Subject: [PATCH] Created Getting Started (markdown)

---
 Getting-Started.md | 113 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 113 insertions(+)
 create mode 100644 Getting-Started.md

diff --git a/Getting-Started.md b/Getting-Started.md
new file mode 100644
index 0000000..10ffb6e
--- /dev/null
+++ b/Getting-Started.md
@@ -0,0 +1,113 @@
+# Getting Started
+
+## Prerequisites
+
+### General Requirements
+- Git 2.x+
+- Docker & Docker Compose
+- Python 3.11+ (3.13+ for newer projects)
+- Node.js 20+ (for frontend projects)
+
+### Cloning the Repository
+
+This repo uses **git submodules** for the fullstack template. Clone with:
+
+```bash
+git clone --recurse-submodules https://github.com/CarterPerez-dev/Cybersecurity-Projects.git
+```
+
+If you already cloned without submodules:
+
+```bash
+cd Cybersecurity-Projects
+git submodule update --init --recursive
+```
+
+### Updating Submodules
+
+To pull the latest changes from submodules:
+
+```bash
+git submodule update --remote
+```
+
+## Running Projects
+
+Each completed project in `PROJECTS/` has its own setup. Most use Docker Compose for easy deployment.
+
+### Quick Start Pattern
+
+Most projects follow this pattern:
+
+```bash
+cd PROJECTS/<project-name>
+
+# Development mode
+make dev
+# or
+docker compose -f dev.compose.yml up --build
+
+# Production mode
+make prod
+# or
+docker compose up --build
+```
+
+### Project-Specific Instructions
+
+| Project | Setup Command | Access |
+|---------|--------------|--------|
+| API Security Scanner | `make dev` | http://localhost:3000 |
+| Encrypted P2P Chat | `make dev` | http://localhost:3000 |
+| Keylogger | `python keylogger.py` | CLI output |
+
+## Development Environment
+
+### Recommended Tools
+
+- **IDE:** VS Code with Python, TypeScript, Docker extensions
+- **API Testing:** Bruno, Postman, or httpie
+- **Database:** DBeaver or pgAdmin for PostgreSQL
+- **Network:** Wireshark for packet analysis
+
+### Python Setup
+
+```bash
+# Create virtual environment
+python -m venv .venv
+source .venv/bin/activate  # Linux/Mac
+.venv\Scripts\activate     # Windows
+
+# Install dependencies
+pip install -e ".[dev]"
+```
+
+### Node.js Setup
+
+```bash
+# Install dependencies
+npm install
+# or
+pnpm install
+
+# Development server
+npm run dev
+```
+
+## Environment Variables
+
+Each project has a `.env.example` file. Copy and configure:
+
+```bash
+cp .env.example .env
+# Edit .env with your values
+```
+
+Never commit `.env` files with secrets.
+
+## Next Steps
+
+1. Pick a project from the [Project Roadmap](Project-Roadmap)
+2. Read the project-specific wiki page
+3. Clone and run locally
+4. Explore the code and learn
\ No newline at end of file