Skip to content

Commit e623bd1

Browse files
Update README.md
1 parent 2f219f0 commit e623bd1

1 file changed

Lines changed: 27 additions & 33 deletions

File tree

README.md

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,43 @@
11

2-
# Cipher Academy: Advanced Ethical Hacking Simulation Platform
2+
# Cipher Academy
33

4-
Cipher Academy is a sophisticated, browser-based educational environment designed to demystify offensive security concepts and Python programming. Built with React and TypeScript, it provides a safe, isolated sandbox where users can practice penetration testing methodologies, analyze vulnerabilities, and execute Python scripts directly in the browser.
4+
Browser-based offensive security sandbox. Runs Python 3.11 entirely client-side using WebAssembly (Pyodide).
55

6-
## Core Architecture
6+
## Architecture Reference
77

8-
The platform operates as a **Progressive Web App (PWA)**, ensuring full offline capabilities and native-like performance on mobile devices. It leverages a hybrid execution engine:
8+
| Component | Implementation | Notes |
9+
| :--- | :--- | :--- |
10+
| **Runtime** | Pyodide / Web Workers | Isolates code execution from the main thread |
11+
| **Shell** | Virtualized Terminal | Simulates Kali Linux environment commands |
12+
| **Storage** | IndexedDB | Offline persistence for user progress |
13+
| **Content** | Static Modules | Dual-language (Amharic/English) curriculum |
914

10-
* **Virtual Terminal:** A simulated Kali Linux shell environment.
11-
* **Python Runtime:** Browser-based Python execution via Web Workers (Pyodide), allowing real-time code analysis without server-side dependencies.
12-
* **AI Tutor:** Integrated Gemini AI assistance for code auditing and logic explanation.
15+
## Core Modules
1316

14-
## Key Features
17+
1. **Curriculum**
18+
* Python Syntax & Logic
19+
* Network Reconnaissance (Socket programming)
20+
* Exploit Development (Keyloggers, ARP logic)
1521

16-
### 1. Interactive Learning Roadmap
17-
A structured curriculum guiding users from basic Python syntax to advanced exploit development. Content is delivered in Amharic to bridge the language gap in cybersecurity education.
22+
2. **CTF Arena**
23+
* **Cryptography:** XOR, Base64, RSA, Hashing
24+
* **Forensics:** Log analysis, Hex dumps, Metadata extraction
25+
* **Web:** SQLi logic, Header manipulation, Cookie tampering
1826

19-
### 2. Capture The Flag (CTF) Arena
20-
Real-world scenario simulations ranging from cryptography puzzles to log analysis and steganography.
21-
* **Reverse Engineering:** Logic gates and mathematical puzzles.
22-
* **Cryptography:** Decrypting ciphers and hash cracking.
23-
* **Forensics:** Analyzing server logs and corrupted files.
27+
3. **IDE**
28+
* In-browser code editor
29+
* Real-time syntax highlighting
30+
* Vulnerability scanning simulation
2431

25-
### 3. Integrated Development Environment (IDE)
26-
* **Code Editor:** Syntax highlighting and auto-completion.
27-
* **Console:** Real-time output visualization.
28-
* **Security Auditor:** Automated vulnerability scanning for user scripts.
32+
## Setup
2933

30-
## Technical Stack
31-
32-
* **Frontend:** React 18, TypeScript, Vite
33-
* **Styling:** Tailwind CSS (Dark Mode optimized)
34-
* **Runtime:** Web Workers, Pyodide (Python 3.11)
35-
* **State Management:** IndexedDB (Offline Persistence)
36-
* **AI Integration:** Google Gemini API
37-
38-
## Installation
39-
40-
This project is designed to be deployed as a static site or installed as a PWA.
34+
Standard Vite project structure.
4135

4236
```bash
4337
# Install dependencies
4438
npm install
4539

46-
# Start development server
40+
# Start local server
4741
npm run dev
4842

4943
# Build for production
@@ -52,8 +46,8 @@ npm run build
5246

5347
## Deployment
5448

55-
The application is configured for automated deployment via GitHub Actions. Pushing to the `main` branch triggers a build process that generates a production-ready artifact hosted on GitHub Pages.
49+
Configured for GitHub Pages. Pushing to `main` triggers the build workflow via GitHub Actions.
5650

5751
## License
5852

59-
MIT License. Educational use only.
53+
MIT.

0 commit comments

Comments
 (0)