Skip to content

Commit a9a02d1

Browse files
authored
Create README.md
1 parent e3b0f9e commit a9a02d1

File tree

1 file changed

+137
-0
lines changed

1 file changed

+137
-0
lines changed

README.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<h1 align="center">🌊 CodeHarborHub - LeetCode-Style Coding Platform</h1>
2+
3+
<p align="center">
4+
<b>A modern, powerful, open-source code evaluation platform for practicing coding challenges.</b><br/>
5+
<i>Built with ❤️ by developers, for developers.</i>
6+
</p>
7+
8+
<p align="center">
9+
<img src="https://img.shields.io/github/stars/CodeHarborHub/coding-platform?style=social" />
10+
<img src="https://img.shields.io/github/issues/CodeHarborHub/coding-platform" />
11+
<img src="https://img.shields.io/github/contributors/CodeHarborHub/coding-platform" />
12+
<img src="https://img.shields.io/github/license/CodeHarborHub/coding-platform" />
13+
</p>
14+
15+
---
16+
17+
## 📌 Overview
18+
19+
**CodeHarborHub** is a powerful coding challenge platform designed for learners and professionals to practice Data Structures and Algorithms in a real-time environment — just like LeetCode and HackerRank.
20+
21+
💡 Supports:
22+
- Problem solving with editor
23+
- Custom test cases
24+
- Submissions and results
25+
- Hints, examples, and constraints
26+
- Difficulty-based filtering
27+
- Future leaderboard & backend integration
28+
29+
---
30+
31+
## 🚀 Live Demo
32+
33+
🔗 [Live Preview](https://codeharborhub-coding-platform.vercel.app/)
34+
🔗 [GitHub Org (CodeHarborHub)](https://github.com/codeharborhub)
35+
36+
---
37+
38+
## 🧰 Tech Stack
39+
40+
- ⚛️ **Frontend**: React.js (Vite)
41+
- 🎨 **Styling**: Tailwind CSS
42+
- 🧠 **Editor**: CodeMirror (or Monaco)
43+
- ⚙️ **Planned Backend**: Node.js + Express (API), MongoDB
44+
45+
---
46+
47+
## 📂 Project Structure
48+
49+
```
50+
📦 coding-platform
51+
┣ 📁 public
52+
┣ 📁 src
53+
┃ ┣ 📁 components
54+
┃ ┣ 📁 pages
55+
┃ ┣ 📁 data # problem data as JSON/JS
56+
┃ ┣ 📁 utils # helpers for evaluation, parsing
57+
┃ ┣ 📁 assets # icons/images
58+
┃ ┣ App.jsx
59+
┃ ┗ main.jsx
60+
┣ 📄 README.md
61+
┣ 📄 CONTRIBUTING.md
62+
┣ 📄 LICENSE
63+
┣ 📄 CODE_OF_CONDUCT.md
64+
┣ 📄 .github/
65+
┃ ┣ 📁 workflows # GitHub Actions
66+
┃ ┗ 📄 ISSUE\_TEMPLATE.md
67+
┣ 📄 package.json
68+
┣ 📄 vite.config.js
69+
70+
```
71+
72+
---
73+
74+
## 🧪 Features
75+
76+
✅ Real-time code editor
77+
✅ Problem detail with constraints, examples, and hints
78+
✅ Tags: Arrays, Strings, DP, Two Pointers
79+
✅ Difficulty labels: Easy, Medium, Hard
80+
✅ Dark/light mode toggle
81+
✅ Mobile-responsive
82+
🚧 Submissions & leaderboard (in progress)
83+
🚧 User login & profile dashboard (planned)
84+
85+
---
86+
87+
## 💡 How to Contribute
88+
89+
We're actively looking for contributors! Found a bug or have a feature idea?
90+
91+
1. 🍴 Fork this repo
92+
2. 🛠️ Clone it locally:
93+
```bash
94+
git clone https://github.com/codeharborhub/coding-platform.git
95+
cd coding-platform
96+
npm install
97+
npm run dev
98+
```
99+
100+
3. ✅ Fix a bug or add a feature
101+
4. 🔁 Submit a Pull Request
102+
103+
📚 Read our [CONTRIBUTING.md](./CONTRIBUTING.md) before you begin.
104+
105+
---
106+
107+
## 🐛 Known Bugs & Improvements
108+
109+
* 🐞 Code execution needs custom logic per language
110+
* 🧩 Responsive layout can break on small screens
111+
* 🪄 Enhance test result output for more clarity
112+
* 💾 Backend needed for persistent submissions
113+
114+
Feel free to help us solve any of these!
115+
116+
---
117+
118+
## 🛡️ License
119+
120+
This project is licensed under the [MIT License](./LICENSE).
121+
122+
---
123+
124+
## 🤝 Support & Community
125+
126+
Have questions? Want to collaborate?
127+
128+
* 📬 Contact: `ajaydhangar49@gmail.com`
129+
* 💬 Join the [Discussion Forum](https://github.com/codeharborhub/coding-platform/discussions)
130+
* ⭐ Star the repo to support us!
131+
132+
---
133+
134+
## ✨ Contributors
135+
136+
Thanks to these wonderful people! 🙌
137+
[Contribute](https://github.com/codeharborhub/coding-platform/graphs/contributors)

0 commit comments

Comments
 (0)