Created Getting Started (markdown)
parent
da94d18283
commit
c0eaffefff
|
|
@ -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
|
||||
Loading…
Reference in New Issue