diff --git a/README.md b/README.md index a5a0b255..d429c847 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ + +
recode hive logo
-

recode hive

- + +

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors) @@ -19,15 +21,35 @@ **Your all-in-one resource for learning Git, GitHub, Python, and Next.js through comprehensive tutorials and hands-on projects.** [Website](https://recodehive.com/) • [Documentation](https://recodehive.com/docs) • [Contributing](community/contributing-guidelines.md) • [Discord](https://discord.gg/Yxv9RA3r) +
+ +
---- + +

## 📖 About 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. + + +## ✨ Vision +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. + + + +## 🎯 Mission + +- Build an accessible, high‑quality hub for learning Git, GitHub, Python, and Next.js. +- Turn learning into doing with guided setups, real projects, and contribution pathways. +- Sustain a vibrant community that celebrates progress with challenges, leaderboards, and mentorship. +- Keep everything open, transparent, and contributor‑friendly. + + + ## ✨ Features - **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 - **User Dashboard** – Personalized space to monitor your completed tutorials, achievements, and activity - **Community & Collaboration** – Engage with other learners, share tips, and collaborate on projects -## 🚀 Quick Start + -### Prerequisites +## 💡 Why Recode-website +● Learn by building: move from tutorial to working project without guesswork. +● All-in-one: docs, guides, challenges, and a dashboard in one place. +● Community-first: collaborate, ask questions, and level up together. +● Career momentum: showcase contributions, climb the leaderboard, and share verifiable progress. +● Modern stack: Docusaurus + React + TypeScript, Tailwind, Radix UI, Framer Motion. +● Open-source: extensible, auditable, and built by contributors like you. -- [Node.js](https://nodejs.org/) ≥ 18 + + +## 🧩 Prerequisites +Set these up before running locally or contributing: + +- Node.js 18.x or newer (LTS recommended) +- Git (for cloning and contributing) +- npm (bundled with Node.js) or your preferred package manager +Optional: - [Docker](https://docs.docker.com/engine/install/) (optional, for containerized development) -- Docker Compose (optional) +- nvm-windows (to switch Node versions if needed) +- Docker Compose +- A GitHub account (for forking and PRs) + + +## 🚀 Quick Start ### Installation **Clone the repository:** @@ -87,6 +128,33 @@ npm run build npm run serve ``` + + +## 🛠️ Troubleshooting +Common issues and quick fixes (Windows PowerShell friendly): + +- Node version mismatch + - Symptom: install/build errors or unexpected syntax errors + - Fix: Use Node 18.x (LTS). Consider nvm-windows to switch versions. + - Optional commands: + - ```node -v``` + - ```npm cache verify``` +- Port 3000 already in use + - Symptom: Dev server fails to start + - Fix: Kill the process on port 3000 or change the port. + - Optional commands: + - netstat -ano | findstr :3000 + - taskkill /PID /F +- Dependency/install errors + - Symptom: npm install fails with peer/audit/compile errors + - Fix: Reinstall cleanly. + - Optional commands: + - ```Remove-Item -Recurse -Force node_modules``` + - ```Remove-Item -Force package-lock.json``` + - ```npm install``` + + + ## 🛠️ Tech Stack ### Core Technologies @@ -101,6 +169,14 @@ npm run serve - **Linting & Formatting:** ESLint, Prettier - **Type Checking:** TypeScript (`tsc`) + + +## 🔁 Project Flowchart + +Flowchart + + + ## 📁 Project Structure ``` @@ -155,6 +231,8 @@ recode-website/ └── ... ``` + + ## 🤝 Contributing 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 **Submit a Pull Request** with a detailed description of your changes + + ### Video Tutorial
@@ -215,6 +295,8 @@ git push origin feature/your-feature-name For detailed guidelines, please refer to our [Contributing Guidelines](community/contributing-guidelines.md). + + ## 📚 Documentation - [Contributing Guidelines](community/contributing-guidelines.md) @@ -222,6 +304,8 @@ For detailed guidelines, please refer to our [Contributing Guidelines](community - [Understanding Lint Checks](community/understand-lint-checks.md) - [Our Documentation Standards](community/our-documentation.md) + + ## 💬 Community Join our community and connect with fellow learners: @@ -229,6 +313,8 @@ Join our community and connect with fellow learners: [![Discord](https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logo=Discord&logoColor=white)](https://discord.gg/Yxv9RA3r) [![LinkedIn](https://img.shields.io/badge/Follow%20on-LinkedIn-blue?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/sanjay-k-v/) + + ## 📊 Project Statistics ![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: ![GitHub repo size](https://img.shields.io/github/repo-size/RecodeHive/recode-website) ![Last commit](https://img.shields.io/github/last-commit/RecodeHive/recode-website) + + ## 👥 Contributors 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 + + ## ⚖️ License This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details. + + ## 📬 Stay Connected Stay up to date with the latest from recode hive: @@ -263,14 +355,14 @@ Stay up to date with the latest from recode hive: - **YouTube:** [@RecodeHive](https://www.youtube.com/@RecodeHive) - **Newsletter:** [Subscribe](https://recodehive.substack.com/) ---- +
**Happy open-source contributions—here's to your career success! 🎉**

- +

Made with ❤️ by the recode hive community