✨ Add: CONTRIBUTING.md for project contribution guidelines and update README.md to streamline content

yashksaini-coder · yashksaini-coder · commit 9cef3dc67a31 · 2025-04-04T11:23:40.000+05:30
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,97 @@
+## <u>How can you Contrbitute to this Project?</u>
+
+#### 1. Fork the Repository
+
+To contribute to the project, you need to fork the repository to your GitHub account. You can do this by clicking on the [Fork](https://github.com/yashksaini-coder/leetcode-journal/fork) button at the top right corner of the repository page.
+
+#### 2. Clone the Repository
+
+```bash
+git clone https://github.com/yashksaini-coder/leetcode-journal
+
+# Navigate to the project directory
+cd leetcode-journal
+```
+
+#### 3. Install Dependencies
+
+```bash
+npm install
+```
+
+#### 4. Set Up Supabase
+
+- Go to the [Supabase](https://supabase.io/) website and create an account.
+- Create a new project in Supabase.
+- Navigate to the API section and create a new API key.
+- Copy the API key and the URL of your Supabase project.
+
+#### 5. Set Up Environment Variables
+
+- Create a new file named `.env` in the root directory of the project.
+
+- Add the following environment variables to the file:
+
+```bash
+NEXT_PUBLIC_SUPABASE_URL = your-supabase-url
+NEXT_PUBLIC_SUPABASE_ANON_KEY = your-anon-key
+DATABASE_URL = your-database-url
+```
+
+#### 6. Start the Application
+
+```bash
+# Start the application
+npm run dev
+```
+
+#### 7. Open the app in your browser
+
+You should now be able to access the application at [http://localhost:3000](http://localhost:3000)
+
+## Contributing
+
+We welcome contributions from the community! To get started, you can follow the steps below:
+
+#### 7. Create a New Branch
+
+```bash
+# Create a new branch for your feature or fix
+git checkout -b feature/your-feature-name
+```
+
+#### 8. Make sure your changes adhere to the project standards and structure. Stage all changes
+
+```bash
+git add .
+```
+
+#### 9. Commit your Changes, with a descriptive message
+
+```bash
+git commit -m "Description of the feature or fix"
+```
+
+#### 10. Push your Changes into the branch to your forked repository
+
+```bash
+# Push your branch to your forked repository
+git push origin feature/your-feature-name
+```
+
+#### 11. Create a Pull Request
+
+- Go to the original repository on GitHub and open a new Pull Request
+- Provide a clear description of your changes in the Pull Request.
+
+#### 12. Wait for Review
+
+- Once you have opened a Pull Request, the maintainers will review your changes and provide feedback.
+
+## ✨ Contributors
+
+All Thanks to our contributors 💙
+
+[![GitHub Contributors](https://contrib.rocks/image?repo=yashksaini-coder/Leetcode-Journal)](https://github.com/yashksaini-coder/Leetcode-Journal/graphs/contributors)
+
+<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
diff --git a/README.md b/README.md
@@ -1,45 +1,20 @@
 <!-- ![Leetcode-Journal](https://socialify.git.ci/yashksaini-coder/Leetcode-Journal/image?font=Rokkitt&name=1&owner=1&pattern=Solid&theme=Auto) -->
 
-<div align="center">
-    <img src="https://github.com/user-attachments/assets/e2fad388-7a5b-41fb-95c6-ff7c983193dc">
-</div>
+<img align="center" src="https://github.com/user-attachments/assets/e2fad388-7a5b-41fb-95c6-ff7c983193dc">
 
 # [Leetcode Journal](https://leetcode-journal.vercel.app/)
 
 **Leetcode Journal** is a NextJS Full stack application designed to help developers track, assess, and analyze their problem-solving journey on LeetCode. It provides a better way to show the progress of a developer of their coding journey.
 
 ## Project Overview
 
-
 [![wakatime](https://wakatime.com/badge/user/9a827e04-5df8-4525-ace8-e88326bbf87a/project/cbc54911-d322-42cb-a897-c093a59e53ad.svg?style=social)](https://wakatime.com/badge/user/9a827e04-5df8-4525-ace8-e88326bbf87a/project/cbc54911-d322-42cb-a897-c093a59e53ad)
 
-<!-- <table align="center">
-    <thead align="center">
-        <tr border: 2px;>
-            <td><b>🌟 Stars</b></td>
-            <td><b>🍴 Forks</b></td>
-            <td><b>🐛 Issues</b></td>
-            <td><b>🔔 Open PRs</b></td>
-            <td><b>🔕 Close PRs</b></td>
-        </tr>
-     </thead>
-    <tbody>
-         <tr>
-            <td><img alt="Stars" src="https://img.shields.io/github/stars/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
-             <td><img alt="Forks" src="https://img.shields.io/github/forks/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
-            <td><img alt="Issues" src="https://img.shields.io/github/issues/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
-            <td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
-           <td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/yashksaini-coder/Leetcode-Journal?style=flat&color=green&logo=github"/></td>
-        </tr>
-    </tbody>
-</table> -->
-
 ## Key Features
 
 Leetcode Journal offers the following key features:
 
-- **📝 AI Agent:** An AI Agent that is capable of solving and providing  assistance to the developers to help them solve leetcode problems
-- **🗂️ Categorize Problems:** Tag problems by difficulty, topic, or category for better organization.
+- **🗂️ Problems Dashboard:** Showcaseing problems by difficulty, topic, or category for better organization.
 - **📈 Track Progress:** Visualize your journey with detailed progress tracking.
 - **📊 Performance Analytics:** Leverage charts and insights to discover patterns in your performance.
 
@@ -73,102 +48,39 @@ Leetcode Journal leverages cutting-edge technologies to deliver a seamless user
     </tr>
 </table>
 
-### How can you Contrbitute to this Project? 
-
-#### 1. Fork the Repository
-
-To contribute to the project, you need to fork the repository to your GitHub account. You can do this by clicking on the [Fork](https://github.com/yashksaini-coder/leetcode-journal/fork) button at the top right corner of the repository page.
-
-#### 2. Clone the Repository
-```bash
-git clone https://github.com/yashksaini-coder/leetcode-journal
-
-# Navigate to the project directory
-cd leetcode-journal  
-```
-
-#### 3. Install Dependencies
-```bash
-npm install  
-```
-
-#### 4. Set Up Supabase
-
-- Go to the [Supabase](https://supabase.io/) website and create an account.
-- Create a new project in Supabase.
-- Navigate to the API section and create a new API key.
-- Copy the API key and the URL of your Supabase project.
-
-#### %. Set Up Environment Variables
-- Create a new file named `.env` in the root directory of the project.
-- Add the following environment variables to the file:
-```bash
-NEXT_PUBLIC_SUPABASE_URL = your-supabase-url
-NEXT_PUBLIC_SUPABASE_ANON_KEY = your-anon-key
-DATABASE_URL = your-database-url
-```
-
-#### 6. Start the Application
-```bash
-# Start the application  
-npm run dev 
-```
-
-#### 7. Open the app in your browser 
-You should now be able to access the application at [http://localhost:3000](http://localhost:3000)
-
-## Contributing
-We welcome contributions from the community! To get started, you can follow the steps below:
-
-#### 7. Create a New Branch
-
-```bash
-# Create a new branch for your feature or fix
-git checkout -b feature/your-feature-name
-```
-
-#### 8. Make sure your changes adhere to the project standards and structure. Stage all changes
-
-```bash
-git add .
-```
-#### 9. Commit your Changes, with a descriptive message
-
-```bash
-git commit -m "Description of the feature or fix"
-```
-#### 10. Push your Changes into the branch to your forked repository
-
-```bash
-# Push your branch to your forked repository
-git push origin feature/your-feature-name
-```
-
-#### 11. Create a Pull Request
-
-- Go to the original repository on GitHub and open a new Pull Request
-- Provide a clear description of your changes in the Pull Request.
-
-#### 12. Wait for Review
-
-- Once you have opened a Pull Request, the maintainers will review your changes and provide feedback.
-
-## ✨ Contributors
-
-All Thanks to our contributors 💙
-
-[![GitHub Contributors](https://contrib.rocks/image?repo=yashksaini-coder/Leetcode-Journal)](https://github.com/yashksaini-coder/Leetcode-Journal/graphs/contributors)
-
-<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
-
-## Stargazers ❤️
-
-<div align='left'>
-
-[![Stargazers repo roster for @yashksaini-coder/leetcode-journal](https://reporoster.com/stars/yashksaini-coder/leetcode-journal)](https://github.com/yashksaini-coder/leetcode-journal/stargazers)
-
-</div>
-
-## Forkers ❤️
-
-[![Forkers repo roster for @yashksaini-coder/Leetcode-Journal](https://reporoster.com/forks/yashksaini-coder/Leetcode-Journal)](https://github.com/yashksaini-coder/Leetcode-Journal/network/members)
+---
+
+<a href="https://github.com/yashksaini-coder">
+    <table>
+        <tbody>
+            <tr>
+                <td align="left" valign="top" width="14.28%">
+                    <img src="https://github.com/yashksaini-coder.png?s=60" width="130px;"/>
+                    <br/>
+                    <h4 align="center">
+                        <b>Yash K. Saini</b>
+                    </h4>
+                    <div align="center">
+                        <p>(Author)</p>
+                    </div>
+                </td>
+                <td align="left" valign="top" width="85%">
+                    <p>
+                        👋 Hi there! I'm <u><em><strong>Yash K. Saini</strong></em></u>, a self-taught software developer and a computer science student from India.
+                    </p>
+                    <ul>
+                     <li>
+                        I love building & contributing to Open Source software solutions & projects that help solve real-world problems.
+                    </li>
+                    <li>
+                        I want to build products & systems that can benefit & solve problems for many other DEVs.
+                    </li>
+                </td>
+            </tr>
+        </tbody>
+    </table>
+</a>
+
+<p align="center">
+    <strong>🌟 If you find this project helpful, please give it a star on GitHub! 🌟</strong>
+</p>
