Skip to content

Commit 94f8f4c

Browse files
authored
Revise README.md for clarity and additional details
Updated README.md to enhance content and structure, including new sections on vision, mission, and prerequisites.
1 parent 662a1d7 commit 94f8f4c

1 file changed

Lines changed: 101 additions & 9 deletions

File tree

README.md

Lines changed: 101 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
2+
13
<div align="center">
24
<a href="https://www.recodehive.com">
35
<img src="static/icons/Logo-512X512.png" alt="recode hive logo" width="150" />
46
</a>
57
</div>
6-
78
<h1 align="center">recode hive</h1>
8-
9+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
10+
<br><br>
911
<div align="center">
1012

1113
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
@@ -19,15 +21,35 @@
1921
**Your all-in-one resource for learning Git, GitHub, Python, and Next.js through comprehensive tutorials and hands-on projects.**
2022

2123
[Website](https://recodehive.com/)[Documentation](https://recodehive.com/docs)[Contributing](community/contributing-guidelines.md)[Discord](https://discord.gg/Yxv9RA3r)
24+
<div align="center">
25+
<img align="center"src="https://github.com/user-attachments/assets/fddcdbcd-5ea2-4416-9f59-ca7fd9394aca" width="300">
26+
</div>
2227

2328
</div>
2429

25-
---
30+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
31+
<br><br>
2632

2733
## 📖 About
2834

2935
recode hive is an open-source educational platform built to help developers master essential technologies through interactive tutorials, practical guides, and community-driven learning. Whether you're a beginner taking your first steps in programming or an advanced developer looking to sharpen your skills, recode hive provides the resources you need.
3036

37+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="700">
38+
39+
## ✨ Vision
40+
Empower every learner to master practical software skills through clear tutorials, hands-on projects, and a supportive open‑source community—so you can build confidently, ship faster, and grow your career.
41+
42+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
43+
44+
## 🎯 Mission
45+
46+
- Build an accessible, high‑quality hub for learning Git, GitHub, Python, and Next.js.
47+
- Turn learning into doing with guided setups, real projects, and contribution pathways.
48+
- Sustain a vibrant community that celebrates progress with challenges, leaderboards, and mentorship.
49+
- Keep everything open, transparent, and contributor‑friendly.
50+
51+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
52+
3153
## ✨ Features
3254

3355
- **Comprehensive Tutorials** – Step-by-step guides for Git, GitHub, Python, and Next.js, suitable for beginners and advanced users
@@ -38,14 +60,33 @@ recode hive is an open-source educational platform built to help developers mast
3860
- **User Dashboard** – Personalized space to monitor your completed tutorials, achievements, and activity
3961
- **Community & Collaboration** – Engage with other learners, share tips, and collaborate on projects
4062

41-
## 🚀 Quick Start
63+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
4264

43-
### Prerequisites
65+
## 💡 Why Recode-website
66+
● Learn by building: move from tutorial to working project without guesswork.
67+
● All-in-one: docs, guides, challenges, and a dashboard in one place.
68+
● Community-first: collaborate, ask questions, and level up together.
69+
● Career momentum: showcase contributions, climb the leaderboard, and share verifiable progress.
70+
● Modern stack: Docusaurus + React + TypeScript, Tailwind, Radix UI, Framer Motion.
71+
● Open-source: extensible, auditable, and built by contributors like you.
4472

45-
- [Node.js](https://nodejs.org/) ≥ 18
73+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
74+
75+
## 🧩 Prerequisites
76+
Set these up before running locally or contributing:
77+
78+
- Node.js 18.x or newer (LTS recommended)
79+
- Git (for cloning and contributing)
80+
- npm (bundled with Node.js) or your preferred package manager
81+
Optional:
4682
- [Docker](https://docs.docker.com/engine/install/) (optional, for containerized development)
47-
- Docker Compose (optional)
83+
- nvm-windows (to switch Node versions if needed)
84+
- Docker Compose
85+
- A GitHub account (for forking and PRs)
86+
87+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
4888

89+
## 🚀 Quick Start
4990
### Installation
5091

5192
**Clone the repository:**
@@ -87,6 +128,33 @@ npm run build
87128
npm run serve
88129
```
89130

131+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
132+
133+
## 🛠️ Troubleshooting
134+
Common issues and quick fixes (Windows PowerShell friendly):
135+
136+
- Node version mismatch
137+
- Symptom: install/build errors or unexpected syntax errors
138+
- Fix: Use Node 18.x (LTS). Consider nvm-windows to switch versions.
139+
- Optional commands:
140+
- ```node -v```
141+
- ```npm cache verify```
142+
- Port 3000 already in use
143+
- Symptom: Dev server fails to start
144+
- Fix: Kill the process on port 3000 or change the port.
145+
- Optional commands:
146+
- netstat -ano | findstr :3000
147+
- taskkill /PID <pid> /F
148+
- Dependency/install errors
149+
- Symptom: npm install fails with peer/audit/compile errors
150+
- Fix: Reinstall cleanly.
151+
- Optional commands:
152+
- ```Remove-Item -Recurse -Force node_modules```
153+
- ```Remove-Item -Force package-lock.json```
154+
- ```npm install```
155+
156+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
157+
90158
## 🛠️ Tech Stack
91159

92160
### Core Technologies
@@ -101,6 +169,14 @@ npm run serve
101169
- **Linting & Formatting:** ESLint, Prettier
102170
- **Type Checking:** TypeScript (`tsc`)
103171

172+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
173+
174+
## 🔁 Project Flowchart
175+
176+
<img width="1024" height="1024" alt="Flowchart" src="https://github.com/user-attachments/assets/df09460d-74f3-4f89-81d8-a74cebf303f5" />
177+
178+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
179+
104180
## 📁 Project Structure
105181

106182
```
@@ -155,6 +231,8 @@ recode-website/
155231
└── ...
156232
```
157233

234+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
235+
158236
## 🤝 Contributing
159237

160238
We welcome contributions from developers of all skill levels! Here's how you can get started:
@@ -202,6 +280,8 @@ git push origin feature/your-feature-name
202280

203281
**Submit a Pull Request** with a detailed description of your changes
204282

283+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
284+
205285
### Video Tutorial
206286

207287
<div>
@@ -215,20 +295,26 @@ git push origin feature/your-feature-name
215295

216296
For detailed guidelines, please refer to our [Contributing Guidelines](community/contributing-guidelines.md).
217297

298+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
299+
218300
## 📚 Documentation
219301

220302
- [Contributing Guidelines](community/contributing-guidelines.md)
221303
- [Code of Conduct](CODE_OF_CONDUCT.md)
222304
- [Understanding Lint Checks](community/understand-lint-checks.md)
223305
- [Our Documentation Standards](community/our-documentation.md)
224306

307+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
308+
225309
## 💬 Community
226310

227311
Join our community and connect with fellow learners:
228312

229313
[![Discord](https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logo=Discord&logoColor=white)](https://discord.gg/Yxv9RA3r)
230314
[![LinkedIn](https://img.shields.io/badge/Follow%20on-LinkedIn-blue?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/sanjay-k-v/)
231315

316+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
317+
232318
## 📊 Project Statistics
233319

234320
![GitHub commit activity (yearly)](https://img.shields.io/github/commit-activity/y/RecodeHive/recode-website)
@@ -240,6 +326,8 @@ Join our community and connect with fellow learners:
240326
![GitHub repo size](https://img.shields.io/github/repo-size/RecodeHive/recode-website)
241327
![Last commit](https://img.shields.io/github/last-commit/RecodeHive/recode-website)
242328

329+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
330+
243331
## 👥 Contributors
244332

245333
We appreciate all contributions to recode hive! Thank you to everyone who has helped make this project better.
@@ -248,10 +336,14 @@ We appreciate all contributions to recode hive! Thank you to everyone who has he
248336
<img src="https://contrib.rocks/image?repo=RecodeHive/recode-website" />
249337
</a>
250338

339+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
340+
251341
## ⚖️ License
252342

253343
This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details.
254344

345+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
346+
255347
## 📬 Stay Connected
256348

257349
Stay up to date with the latest from recode hive:
@@ -263,14 +355,14 @@ Stay up to date with the latest from recode hive:
263355
- **YouTube:** [@RecodeHive](https://www.youtube.com/@RecodeHive)
264356
- **Newsletter:** [Subscribe](https://recodehive.substack.com/)
265357

266-
---
358+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="1000">
267359

268360
<div align="center">
269361

270362
**Happy open-source contributions—here's to your career success! 🎉**
271363

272364
<p align="center">
273-
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="600">
365+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="500">
274366
</p>
275367

276368
Made with ❤️ by the recode hive community

0 commit comments

Comments
 (0)