-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from kevinzb56/main
Added README for Anti-kaleshi
- Loading branch information
Showing
1 changed file
with
167 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| # Anti-Kaleshi-Inheritance | ||
|
|
||
| <h1 align="center"> | ||
| <a href="https://github.com/CommunityOfCoders/Inheritance-2024"> | ||
| <img src="./Untitled.png" alt="CoC Inheritance 2024" width="500" height="166"> | ||
| </a> | ||
| <br> | ||
| iCode | ||
| </h1> | ||
|
|
||
| <div align="center"> | ||
| <strong>iCode</strong> - All in ONE Coding Progress and Development Dashboard<br> | ||
| CoC Inheritance 2024 <br> <br> | ||
| </div> | ||
| <hr> | ||
|
|
||
| <details> | ||
| <summary>Table of Contents</summary> | ||
|
|
||
| - [Description](#description) | ||
| - [Links](#links) | ||
| - [Tech Stack](#tech-stack) | ||
| - [Progress](#progress) | ||
| - [Future Scope](#future-scope) | ||
| - [Applications](#applications) | ||
| - [Project Setup](#project-setup) | ||
| - [Usage](#usage) | ||
| - [Team Members](#team-members) | ||
| - [Mentors](#mentors) | ||
| - [Screenshots](#screenshots) | ||
|
|
||
| </details> | ||
|
|
||
| ## 📝Description | ||
|
|
||
| General Description:- | ||
|
|
||
| iCode is an innovative web platform designed to empower developers by providing a centralized ecosystem for tracking, learning, and collaborating. The platform integrates multiple coding platforms and development tools to offer a holistic progress tracking experience. | ||
| Key Features: | ||
|
|
||
| Cross-Platform Performance Tracking: Aggregate coding progress from multiple competitive programming platforms including LeetCode, CodeChef, and Codeforces | ||
| AI-Powered Learning Assistant: An intelligent chatbot capable of answering technical questions and providing coding guidance | ||
| Interactive Discussion Channels: Dedicated spaces for developers to share solutions, discuss coding challenges, and collaborate | ||
| GitHub Progress Integration: Real-time tracking of repository contributions, commit history, and open-source involvement | ||
| Personalized Learning Dashboard: Visualize coding statistics, problem-solving trends, and skill development metrics | ||
|
|
||
| The platform facilitates a comprehensive developer growth environment, enabling users to centralize their coding journey, enhance learning, and connect with a community of like-minded developers. | ||
|
|
||
|
|
||
| ## 🔗Links | ||
| - [GitHub Repository](https://github.com/kavya-r30/Anti-Kaleshi-Inheritance) | ||
| - [Demo Video]() | ||
| - [Drive Link to Screenshots of our project]() | ||
| - [Drive Link to Videos of our project]() | ||
| - [Hosted Website Link]() | ||
| - [Hosted Backend Link]() | ||
|
|
||
|
|
||
| ## 🤖Tech-Stack | ||
| <a href="https://www.w3.org/TR/html5/" title="HTML5"><img src="https://github.com/get-icon/geticon/raw/master/icons/html-5.svg" alt="HTML5" width="21px" height="21px"></a> | ||
| <a href="https://www.w3.org/TR/CSS/" title="CSS3"><img src="https://github.com/get-icon/geticon/raw/master/icons/css-3.svg" alt="CSS3" width="21px" height="21px"></a> | ||
| <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" title="JavaScript"><img src="https://github.com/get-icon/geticon/raw/master/icons/javascript.svg" alt="JavaScript" width="21px" height="21px"></a> | ||
| <a href="https://reactjs.org/" title="React"><img src="https://github.com/get-icon/geticon/raw/master/icons/react.svg" alt="React" width="21px" height="21px"></a> | ||
| <a href="https://nodejs.org/" title="Node.js"><img src="https://github.com/get-icon/geticon/raw/master/icons/nodejs-icon.svg" alt="Node.js" width="21px" height="21px"></a> | ||
| <a href="https://expressjs.com/" title="Express"><img src="https://github.com/get-icon/geticon/raw/master/icons/express.svg" alt="Express" width="21px" height="21px"></a> | ||
| <a href="https://www.mongodb.org/" title="MongoDB"><img src="https://github.com/get-icon/geticon/raw/master/icons/mongodb-icon.svg" alt="MongoDB" width="21px" height="21px"></a> | ||
| <a href="https://www.npmjs.com/" title="npm"><img src="https://github.com/get-icon/geticon/raw/master/icons/npm.svg" alt="npm" width="21px" height="21px"></a> | ||
| <a href="https://code.visualstudio.com/" title="Visual Studio Code"><img src="https://github.com/get-icon/geticon/raw/master/icons/visual-studio-code.svg" alt="Visual Studio Code" width="21px" height="21px"></a> | ||
|
|
||
| #### Front-end | ||
|
|
||
| - HTML | ||
| - CSS | ||
| - Tailwind CSS | ||
| - JavaScript | ||
| - React | ||
|
|
||
| #### Back-end | ||
|
|
||
| - NodeJS | ||
| - ExpressJS | ||
| - Mongoose | ||
|
|
||
| #### Database | ||
|
|
||
| - MongoDB Atlas | ||
|
|
||
| #### API Management Platform: | ||
|
|
||
| - Postman | ||
|
|
||
| #### Project Deployment: | ||
|
|
||
| - Vercel (Frontend) | ||
| - Onrender (Backend) | ||
|
|
||
|
|
||
| ## 📈Progress | ||
|
|
||
| List down all the fully implemented features in your project | ||
|
|
||
| - [x] Personal profile page. | ||
| - [x] General discussion page where everyone can interact, even post questions/doubts they have and give answers to the questions others post. | ||
| - [x] All in one Dashboard which displays to user: ratings across platforms, problems solved, heat map to keep track of their progress, the badges they have earnt from coding platforms, and also how many contest they have given. | ||
| - [x] Realtime Contest Tracker in the form of calender to keep the user informed when the upcoming contests are scheduled to take place. | ||
| - [x] AI-powered chatbot to ask questions they have regarding their coding journey and it can even provide users with questions on which they should focus based on their current problem solving progress. | ||
| - [x] Graphs and Charts to track the progress of a user to correctly gauge his skills and to show users journey along the way. | ||
|
|
||
|
|
||
| ## 🔮Future Scope | ||
|
|
||
| List down all the future plans for the project here | ||
| - Leaderboard to display where user stands across their Institution and even in their respective Countries. | ||
| - Exclusive Reward Store (similar to the one of Leetcode). | ||
| - Coin Based reward system to encourage user to daily solve questions. | ||
|
|
||
|
|
||
| ## 💸Applications | ||
| All in one hub: user can keep a track of their coding and development progress without having to multitask between various platforms. | ||
|
|
||
|
|
||
| ## 🛠Project Setup | ||
|
|
||
| 1. Clone the GitHub repo. | ||
| ```bash | ||
| $ git clone https://github.com/kavya-r30/Anti-Kaleshi-Inheritance.git | ||
| ``` | ||
| 2. To start the frontend server: | ||
| ```bash | ||
| $ cd react-app | ||
| $ npm install | ||
| $ npm start | ||
| ``` | ||
|
|
||
| 3. To start the backend server: | ||
| ```bash | ||
| $ cd backend | ||
| $ npm install | ||
| $ npm start | ||
| ``` | ||
|
|
||
|
|
||
| ## 👨💻Team Members | ||
|
|
||
| Add names of your team members with their emails and links to their GitHub accounts | ||
| - [Team Member 1 Kavya Rambhia](https://github.com/kavya-r30): [email protected] | ||
| - [Team Member 2 Kevin Shah](): [email protected] | ||
| - [Team Member 3 Mihir Katakdhond](https://github.com/mihir-k64): [email protected] | ||
| - [Team Member 3 Swayam Shah](https://github.com/Sonu0305): [email protected] | ||
|
|
||
| ## 👨🏫Mentors | ||
|
|
||
| Add names of your mentors with their emails and links to their GitHub accounts | ||
| - [Team Member 1 Aaditya Jayant Padte](https://github.com/Aaditya8C): [email protected] | ||
| - [Team Member 3 Aniket Suresh Jadhav](https://github.com/DevAniket010): [email protected] | ||
|
|
||
| ## 📱Screenshots | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|
|
||
|
|
||
|
|