Update CONTRIBUTING.md and submodule workflow for new structure
- Update CONTRIBUTING.md to reference TEMPLATES/fullstack-template - Fix submodule workflow to use TEMPLATES instead of templates - Update project directory instructions for difficulty-based folders - Add difficulty level definitions and updated examples
This commit is contained in:
CarterPerez-dev
parent
2ef894b4ff
commit
69212e5e8d
|
|
@ -23,7 +23,7 @@ jobs:
|
|||
|
||||
- name: Update submodule to latest
|
||||
run: |
|
||||
git submodule update --remote templates/fullstack-template
|
||||
git submodule update --remote TEMPLATES/fullstack-template
|
||||
|
||||
- name: Check for changes
|
||||
id: changes
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ cd Cybersecurity-Projects
|
|||
|
||||
### 2. Create Your Project Directory
|
||||
|
||||
Create a new directory in `/PROJECTS` with a descriptive, lowercase, hyphenated name.
|
||||
Create a new directory in `/PROJECTS/{difficulty}` where difficulty is `beginner`, `intermediate`, or `advanced`. Use a descriptive, lowercase, hyphenated name for your project.
|
||||
|
||||
**Naming Convention:**
|
||||
- ✅ `reverse-shell-handler`
|
||||
|
|
@ -33,14 +33,19 @@ Create a new directory in `/PROJECTS` with a descriptive, lowercase, hyphenated
|
|||
- ❌ `ReverseShellHandler` (no PascalCase)
|
||||
- ❌ `Reverse-Shell-Handler` (no capital letters)
|
||||
|
||||
**Difficulty Levels:**
|
||||
- **Beginner:** Basic tools, single-file scripts, foundational concepts
|
||||
- **Intermediate:** Multi-component systems, API integrations, moderate complexity
|
||||
- **Advanced:** Full-stack applications, distributed systems, complex architectures
|
||||
|
||||
**Examples:**
|
||||
|
||||
| Project Name | Directory Name |
|
||||
|-------------|----------------|
|
||||
| Reverse Shell Handler | `reverse-shell-handler` |
|
||||
| SIEM Dashboard | `siem-dashboard` |
|
||||
| OAuth Token Analyzer | `oauth-token-analyzer` |
|
||||
| AI Threat Detection | `ai-threat-detection` |
|
||||
| Project Name | Difficulty | Directory Path |
|
||||
|-------------|------------|----------------|
|
||||
| Simple Port Scanner | Beginner | `PROJECTS/beginner/simple-port-scanner` |
|
||||
| OAuth Token Analyzer | Intermediate | `PROJECTS/intermediate/oauth-token-analyzer` |
|
||||
| Bug Bounty Platform | Advanced | `PROJECTS/advanced/bug-bounty-platform` |
|
||||
| API Security Scanner | Intermediate | `PROJECTS/intermediate/api-security-scanner` |
|
||||
|
||||
### 3. Project Structure
|
||||
|
||||
|
|
@ -62,17 +67,29 @@ Ensure your project structure is coherent and uses **intuitive, idiomatic naming
|
|||
**Example Structure:**
|
||||
```
|
||||
PROJECTS/
|
||||
└── your-project-name/
|
||||
├── README.md
|
||||
├── .env.example
|
||||
├── requirements.txt
|
||||
├── docker-compose.yml
|
||||
├── src/
|
||||
│ ├── __init__.py
|
||||
│ ├── main.py
|
||||
│ └── utils/
|
||||
├── tests/
|
||||
└── examples/
|
||||
├── beginner/
|
||||
│ └── simple-port-scanner/
|
||||
│ ├── README.md
|
||||
│ └── src/
|
||||
├── intermediate/
|
||||
│ └── oauth-token-analyzer/
|
||||
│ ├── README.md
|
||||
│ ├── .env.example
|
||||
│ ├── requirements.txt
|
||||
│ ├── src/
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── main.py
|
||||
│ │ └── utils/
|
||||
│ └── tests/
|
||||
└── advanced/
|
||||
└── bug-bounty-platform/
|
||||
├── README.md
|
||||
├── .env.example
|
||||
├── docker-compose.yml
|
||||
├── backend/
|
||||
├── frontend/
|
||||
├── tests/
|
||||
└── examples/
|
||||
```
|
||||
|
||||
### 4. Package Managers if using Python and or Node (Doesn't matter what you use for any other framework/libary/language though)
|
||||
|
|
@ -154,9 +171,9 @@ More info: [YAPF Documentation](https://github.com/google/yapf)
|
|||
|
||||
### 7. Full-Stack Projects
|
||||
|
||||
Building a full-stack application? Consider using this template as a starting point:
|
||||
Building a full-stack application? Use the included template as a starting point:
|
||||
|
||||
**[Fullstack Template](https://github.com/CarterPerez-dev/fullstack-template)** - A production-ready template with FastAPI, React, Docker, and more.
|
||||
**[Fullstack Template](./TEMPLATES/fullstack-template)** - A production-ready template with FastAPI, React, Docker, and more. Check the [GitHub repository](https://github.com/CarterPerez-dev/fullstack-template) for the latest updates.
|
||||
|
||||
### 8. Submit a Pull Request
|
||||
|
||||
|
|
|
|||
10
README.md
10
README.md
|
|
@ -23,7 +23,7 @@
|
|||
<h2 align="center"><strong>View Complete Projects:</strong></h2>
|
||||
<div align="center">
|
||||
<a href="https://github.com/CarterPerez-dev/Cybersecurity-Projects/tree/main/PROJECTS">
|
||||
<img src="https://img.shields.io/badge/Full_Source_Code-10/60-blue?style=for-the-badge&logo=github" alt="Projects"/>
|
||||
<img src="https://img.shields.io/badge/Full_Source_Code-11/60-blue?style=for-the-badge&logo=github" alt="Projects"/>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
|
@ -42,12 +42,6 @@ Tools, courses, certifications, communities, and frameworks for cybersecurity pr
|
|||
|
||||
---
|
||||
|
||||
Big thanks to the current contributors!
|
||||
- [@deniskhud](https://github.com/deniskhud): [Simple Port Scanner](./PROJECTS/beginner/simple-port-scanner)
|
||||
- [@Heritage-XioN](https://github.com/Heritage-XioN): [Metadata Scrubber Tool](./PROJECTS/beginner/metadata-scrubber-tool)
|
||||
|
||||
---
|
||||
|
||||
# Projects
|
||||
|
||||
### Beginner Projects
|
||||
|
|
@ -56,7 +50,7 @@ Big thanks to the current contributors!
|
|||
- **[Keylogger](./PROJECTS/beginner/keylogger)** - Capture keyboard events with timestamps using Python pynput
|
||||
- **[Caesar Cipher](./PROJECTS/beginner/caesar-cipher)** - CLI encryption/decryption tool with brute-force capabilities
|
||||
- **[DNS Lookup CLI Tool](./PROJECTS/beginner/dns-lookup)** - Query DNS records with WHOIS and reverse lookup
|
||||
- **[Simple Vulnerability Scanner](./SYNOPSES/beginner/Simple.Vulnerability.Scanner.md)** - Check software versions against CVE databases
|
||||
- **[Simple Vulnerability Scanner](./PROJECTS/beginner/simple-vulnerability-scanner)** - Check software versions against CVE databases
|
||||
- **[Metadata Scrubber Tool](./PROJECTS/beginner/metadata-scrubber-tool)** - Remove EXIF and privacy-sensitive metadata from files
|
||||
- **[Network Traffic Analyzer](./SYNOPSES/beginner/Network.Traffic.Analyzer.md)** - Capture and analyze network packets with scapy
|
||||
- **[Hash Cracker](./SYNOPSES/beginner/Hash.Cracker.md)** - Dictionary and brute-force hash cracking tool
|
||||
|
|
|
|||
Loading…
Reference in New Issue