Skip to content

Commit 4d4b522

Browse files
committed
(v0.6.1-beta) README Update
Wrote the README.md completely! Its now ship readyy imma ship very sooooon
1 parent 3e62e90 commit 4d4b522

1 file changed

Lines changed: 128 additions & 0 deletions

File tree

README.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!--
12
# Cipher
23
A YSWS concept stressing on Cybersecurity & Cryptography!
34
@@ -10,3 +11,130 @@ WS: yubikeys, hackduckys, Laptops, wifi modules, etc
1011
There'll be bounty's for finding the vulnerability.
1112
1213
PS: There'll be some vulnerable sites (that ill make) and the first person to crack those gets bonus prizes
14+
15+
Copyright (C) 2026 Rupnil Codes
16+
17+
This file is part of CIPHER.
18+
19+
CIPHER is free software: you can redistribute it and/or modify
20+
it under the terms of the AGPL-3.0 License.
21+
-->
22+
23+
<h1 align="center">
24+
C1PH<span>Σ</span>R
25+
</h1>
26+
27+
---
28+
29+
<p align="center">
30+
<img src="https://raw.githubusercontent.com/rupnil-codes/cipher/refs/heads/main/public/banner.png" width="100%" style="max-width: 500px;" alt="CIPHER Banner">
31+
</p>
32+
33+
<p align="center">
34+
<img src="https://img.shields.io/badge/Category-Cybersecurity-black?style=for-the-badge">
35+
<img src="https://img.shields.io/badge/React%20JS-%5E19.2.0-blue?style=for-the-badge&logo=react&logoColor=white" alt="React.JS %5E19.2.4">
36+
<img src="https://img.shields.io/github/license/rupnil-codes/cipher?style=for-the-badge" alt="GNU AGPL 3.0">
37+
<img src="https://hackatime-badge.hackclub.com/U0A4UTULSLE/cipher?style=for-the-badge" alt="Hackatime Badge">
38+
<img src="https://img.shields.io/github/commit-activity/w/rupnil-codes/cipher?style=for-the-badge" alt="Commit Activity">
39+
<img src="https://img.shields.io/github/last-commit/rupnil-codes/cipher?style=for-the-badge" alt="Commit History">
40+
</p>
41+
42+
<h3 align="center">
43+
A YSWS concept stressing on Cybersecurity & Cryptography!
44+
</h3>
45+
46+
---
47+
48+
## Overview
49+
YS: An app, game or site with one specific vulnerability AND another version where you fixed it.
50+
WS: yubikeys, hackduckys, Laptops, wifi modules, etc
51+
There'll be bounty's for finding the vulnerability.
52+
53+
> Most other information can be found on the website!
54+
55+
---
56+
57+
## Requirements
58+
- A modern browser with JS support,
59+
- A keyboard and a mouse,
60+
- Curiosity and sheer will, &
61+
- Basic problem-solving skills
62+
63+
---
64+
65+
## Usage: Quick Start
66+
### Pre-hosted
67+
An instance of the ReactJS app is hosted by me through [Vercel](https://vercel.com/).
68+
You can easily access this hosted instance at [cipher.dino.icu](https://cipher.dino.icu/)!
69+
The hosted website is compatible with most modern browsers and thus most OS.
70+
71+
### Building from source
72+
Idk why you would want to build from the source when i have it deployed, but here u go anyways.
73+
74+
Before building make sure you have the following installed:
75+
- Node.js (Version 20 or higher)
76+
- npm (comes with Node.js) or similar, e.g. pnpm/yarn/etc.
77+
78+
### 1. Clone the repository
79+
```bash
80+
git clone https://github.com/rupnil-codes/cipher.git
81+
cd cipher
82+
```
83+
### 2. Install Dependencies
84+
```bash
85+
npm install
86+
npm update
87+
```
88+
### 3. Run Development Server
89+
```bash
90+
npm run dev
91+
```
92+
or
93+
```bash
94+
npx vite
95+
```
96+
### 4. Build for Production
97+
```bash
98+
npm run build
99+
```
100+
Then the final compiled webapp will be in the `dist/` directory.
101+
102+
---
103+
104+
## Features:
105+
I've tried adding as many features as I could, here are some:
106+
- Minimalistic UI/UX
107+
- Smooth Animations
108+
- Dark mode
109+
- Many details and Links!
110+
111+
---
112+
## Project Status
113+
<p><b>Version:</b> v0.6.1-beta</p>
114+
<p><b>Latest Release Version:</b> v0.6-beta</p>
115+
<p><b>Status:</b> Actively developing as of now</p>
116+
117+
---
118+
119+
## Contributors
120+
There are several well-wishers and playtesters who have helped me improve the app,
121+
either by playtesting or providing valuable feedback. I've listed them in no particular order.
122+
1. [@AVD](https://hackclub.enterprise.slack.com/team/U0823F39GV8),
123+
2. [@Flux3tor](https://github.com/Flux3tor),
124+
3. [@Snxhit_](https://github.com/Snxhit),
125+
4. [@Nx75](https://github.com/Nx75),
126+
5. [@Keyboard1000n17](https://github.com/Keyboard1000n17/OSPedia),
127+
6. [@stunt](https://github.com/Stu67nt)
128+
> If i forgot to mention anyone, pls DM me on slack!
129+
130+
---
131+
132+
<h4 align="center">
133+
Made with 💖 by @rupnil.codes
134+
</h4>
135+
<p align="center">
136+
If you found this project interesting, consider giving it a star :D
137+
</p>
138+
<p align="center">
139+
<a href="https://github.com/rupnil-codes/cipher/issues">Report a Bug</a> or <a href="https://github.com/rupnil-codes/cipher/issues">Suggest a new Feature</a>
140+
</p>

0 commit comments

Comments
 (0)