diff --git a/CodeClip-Chinmayi b/CodeClip-Chinmayi deleted file mode 160000 index b6e51e5c..00000000 --- a/CodeClip-Chinmayi +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b6e51e5c3381769b931a7dcab8550724ee023cab diff --git a/README.md b/README.md index 14327523..b35a2325 100644 --- a/README.md +++ b/README.md @@ -1,118 +1,140 @@ -# πŸͺ„ CodeClip  β€“ Coding Challenge Vault +# πŸͺ„ CodeClip – Coding Challenge Vault -**CodeClip** is a lightweight, fully client-side web app that lets developers **store, solve, run, and share coding challenges** directly in the browser. Built with vanilla **HTML, CSS, and JavaScript**, it is ideal for first-time open-source contributors and is being developed under **GirlScript Summer of Code (GSSoC)**. +[![GitHub stars](https://img.shields.io/github/stars/adikulkarni006/CodeClip?style=social)](https://github.com/adikulkarni006/CodeClip/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/adikulkarni006/CodeClip?style=social)](https://github.com/adikulkarni006/CodeClip/network/members) +[![GitHub issues](https://img.shields.io/github/issues/adikulkarni006/CodeClip)](https://github.com/adikulkarni006/CodeClip/issues) +[![License](https://img.shields.io/github/license/adikulkarni006/CodeClip)](./LICENSE) + +**CodeClip** is a lightweight, fully client-side web app that lets developers **store, solve, run, and share coding challenges directly in the browser**. +Built with **vanilla HTML, CSS, and JavaScript**, it is ideal for first-time open-source contributors and is being developed under **GirlScript Summer of Code (GSSoC)**. + +--- ## ✨ Key Features (Planned & Implemented) -| Category | Feature | Status | -|----------|---------|--------| -| Core Vault | Challenge repository with tags, difficulty, and search | πŸ›  Planned | -| Playback | In-browser code runner (JS sandbox) with console output | πŸ›  Planned | -| Editor | CodeMirror-based editor with themes, linting, and autosave | πŸ›  Planned | -| Sharing | Public solution links, up-votes, and comments | πŸ›  Planned | -| AI Assist | Challenge recommendations based on user history | πŸ›  Planned | -| Accounts | Local profile, progress tracking, badges | πŸ›  Planned | -| UI / UX | Dark-light theme switcher, mobile-first layout | πŸ›  Planned | -| Accessibility | WCAG-compliant color palette & keyboard nav | πŸ›  Planned | -| DevOps | GitHub Pages deploy, CI linting, unit tests | πŸ›  Planned | +| Category | Feature | Status | +|---------------|-----------------------------------------------------------|----------| +| Core Vault | Challenge repository with tags, difficulty, and search | πŸ›  Planned | +| Playback | In-browser code runner (JS sandbox) with console output | πŸ›  Planned | +| Editor | CodeMirror-based editor with themes, linting, and autosave | πŸ›  Planned | +| Sharing | Public solution links, up-votes, and comments | πŸ›  Planned | +| AI Assist | Challenge recommendations based on user history | πŸ›  Planned | +| Accounts | Local profile, progress tracking, badges | πŸ›  Planned | +| UI / UX | Dark-light theme switcher, mobile-first layout | πŸ›  Planned | +| Accessibility | WCAG-compliant color palette & keyboard nav | πŸ›  Planned | +| DevOps | GitHub Pages deploy, CI linting, unit tests | πŸ›  Planned | + +--- ## πŸ—οΈ System Architecture -``` -Client (Browser) ────────────────────────────────────────────┐ -β”‚ β”‚ -β”‚ 1. UI Layer (HTML + CSS) β”‚ -β”‚ β€’ index.html – Landing / dashboard β”‚ -β”‚ β€’ pages/ challenges.html, editor.html, … β”‚ -β”‚ β€’ styles/ main.css, components.css, themes.css β”‚ -β”‚ β”‚ -β”‚ 2. Logic Layer (ES6 Modules) β”‚ -β”‚ β€’ app.js – App bootstrap & router β”‚ -β”‚ β€’ storage.js – LocalStorage API wrapper β”‚ -β”‚ β€’ challenges.js – Challenge CRUD & filters β”‚ -β”‚ β€’ editor.js – CodeMirror integration β”‚ -β”‚ β€’ ai.js – Recommendation engine (future) β”‚ -β”‚ β€’ utils.js – Helpers β”‚ -β”‚ β”‚ -β”‚ 3. Persistence Layer β”‚ -β”‚ β€’ LocalStorage (JSON) β”‚ -β”‚ β€’ IndexedDB (future large data) β”‚ -β”‚ β”‚ -└───────────────────────────────────────────────────────────── - -Offline-first: All data lives in the browser; no backend required. +Client (Browser) +β”‚ +β”œβ”€β”€ UI Layer (HTML + CSS) +β”‚ β€’ index.html – Landing / dashboard +β”‚ β€’ pages/ – challenges.html, editor.html, … +β”‚ β€’ styles/ – main.css, components.css, themes.css +β”‚ +β”œβ”€β”€ Logic Layer (ES6 Modules) +β”‚ β€’ app.js – App bootstrap & router +β”‚ β€’ storage.js – LocalStorage API wrapper +β”‚ β€’ challenges.js – Challenge CRUD & filters +β”‚ β€’ editor.js – CodeMirror integration +β”‚ β€’ ai.js – Recommendation engine (future) +β”‚ β€’ utils.js – Helpers +β”‚ +└── Persistence Layer +β€’ LocalStorage (JSON) +β€’ IndexedDB (future large data) + +yaml +Copy code + +**Offline-first:** All data lives in the browser; no backend required. Optional cloud sync can be added later via GitHub OAuth + Gists. -``` + +--- ## πŸ“‚ Repository Structure -```text codeclip/ β”œβ”€ index.html β”œβ”€ pages/ -β”‚ β”œβ”€ challenges.html -β”‚ β”œβ”€ editor.html -β”‚ └─ profile.html +β”‚ β”œβ”€ challenges.html +β”‚ β”œβ”€ editor.html +β”‚ └─ profile.html β”œβ”€ styles/ -β”‚ β”œβ”€ variables.css -β”‚ β”œβ”€ main.css -β”‚ β”œβ”€ components.css -β”‚ └─ themes.css +β”‚ β”œβ”€ variables.css +β”‚ β”œβ”€ main.css +β”‚ β”œβ”€ components.css +β”‚ └─ themes.css β”œβ”€ scripts/ -β”‚ β”œβ”€ app.js -β”‚ β”œβ”€ storage.js -β”‚ β”œβ”€ challenges.js -β”‚ β”œβ”€ editor.js -β”‚ β”œβ”€ ai.js -β”‚ └─ utils.js +β”‚ β”œβ”€ app.js +β”‚ β”œβ”€ storage.js +β”‚ β”œβ”€ challenges.js +β”‚ β”œβ”€ editor.js +β”‚ β”œβ”€ ai.js +β”‚ └─ utils.js β”œβ”€ assets/ -β”‚ └─ logo.svg +β”‚ └─ logo.svg β”œβ”€ docs/ -β”‚ └─ architecture.png -└─ README.md ← you are here -``` +β”‚ └─ architecture.png +└─ README.md + +yaml +Copy code + +--- ## πŸš€ Getting Started -1. **Clone** - ```bash - git clone https://github.com/opensource-society/CodeClip.git - cd CodeClip - ``` +### Clone Repository + +```bash +git clone https://github.com/adikulkarni006/CodeClip.git +cd CodeClip +Run Locally +Any static server works. With VS Code: + +Install the Live Server extension + +Right-click index.html β†’ β€œOpen with Live Server” + +🀝 Contributing +We welcome contributions of all levels! + +Pick an issue labelled Level 1, Level 2, or Level 3 + +Create a feature branch: + +bash +Copy code +git checkout -b feat/your-feature +Follow the style guide & open a Pull Request -2. **Run Locally** - Any static server works; with VS Code: - 1. Install the *Live Server* extension - 2. Right-click `index.html` β†’ β€œOpen with Live Server” +Be responsive to code reviews -3. **Contribute** - - Pick an issue labelled **Level 1**, **Level 2**, or **Level 3**. - - Create a **feature branch**: `git checkout -b feat/` - - Follow the style guide; submit a pull request; respond to reviews. +πŸ›£οΈ Roadmap (Q3 2025) +βœ… Landing & Vault MVP – basic challenge listing -## πŸ›£οΈ Roadmap (Quarter 3 2025) +πŸ›  Code Editor Integration – CodeMirror + autosave -1. **Landing & Vault MVP** – basic challenge listing πŸ›  -2. **Code Editor Integration** – CodeMirror + autosave πŸ›  -3. **JS Runtime** – iframe sandbox, execution timers πŸ›  -4. **Profile & Stats** – badges, streak calendar πŸ›  -5. **AI Recommendations** – local ML or hosted API πŸ›  -6. **PWA Support** – installable, offline cache πŸ›  -7. **Unit & E2E Tests** – Vitest + Playwright πŸ›  +πŸ›  JS Runtime – iframe sandbox, execution timers -*Issues are filed chronologically in the `/docs/issues.docx` for reference.* +πŸ›  Profile & Stats – badges, streak calendar -## πŸ‘₯ Community & Support +πŸ›  AI Recommendations – local ML or hosted API -| Channel | Purpose | -|---------|---------| -| GitHub Issues | Bug reports, feature requests | -| GitHub Discussions | Q&A, ideas, polls | -| Discord | Real-time chat, pair programming | -| GSSoC Mentors | Onboarding & code reviews | +πŸ›  PWA Support – installable, offline cache -## πŸ”– License +πŸ›  Unit & E2E Tests – Vitest + Playwright -CodeClip is released under the **MIT License** – free for personal & commercial use with attribution. +πŸ‘₯ Community & Support +Channel Purpose +GitHub Issues Bug reports, feature requests +Discussions Q&A, ideas, polls +Discord Real-time chat, pair programming +GSSoC Mentors Onboarding & code reviews -### ⭐ Give the repo a star and join us in building the most accessible coding-challenge vault on the web! +πŸ”– License +Released under the MIT License – free for personal & commercial use with attribution. \ No newline at end of file diff --git a/index.html b/index.html index b667b341..8ce56b61 100644 --- a/index.html +++ b/index.html @@ -39,8 +39,6 @@ content="Solve coding challenges, contribute to open source, and climb the leaderboard on CodeClip. A GSSoC 2025 project for developers." /> - - @@ -86,7 +84,7 @@ - +
@@ -94,7 +92,7 @@

Loading

- +
- -
- + +
+
@@ -146,7 +144,7 @@

Loading

class="img-fluid gssoc-logo" alt="gssoc logo" /> -

GSSOC 2025

+

GSSOC-2025

@@ -168,7 +166,7 @@

contributions.

- +

- + - +
@@ -220,14 +218,14 @@
Frontend Challenges

- + Join Now
- +
@@ -249,14 +247,14 @@
JavaScript Logics

- + Join Now
- +
@@ -279,14 +277,14 @@
Backend Basics

- + Join Now
- +
@@ -309,14 +307,14 @@
UI Design Tasks

- + Join Now
- +
@@ -339,15 +337,14 @@
Open Source Challenges

- + Join Now
- - -
+ +
@@ -367,7 +364,7 @@
JavaScript Mini Projects

- + Join Now
@@ -479,9 +476,9 @@
JavaScript Mini Projects
} - + - +

@@ -522,9 +519,9 @@

- + - +

About CodeClip

@@ -560,7 +557,7 @@

About

- +