Skip to content

Commit 7995c8c

Browse files
docs: ✏️ Update REAMDE
1 parent b22e7e9 commit 7995c8c

File tree

1 file changed

+79
-55
lines changed

1 file changed

+79
-55
lines changed

README.md

Lines changed: 79 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,37 @@
1-
# Leetcode Journal 🚀
1+
![Leetcode-Journal](https://socialify.git.ci/yashksaini-coder/Leetcode-Journal/image?font=Rokkitt&forks=1&issues=1&logo=https%3A%2F%2Fskillicons.dev%2Ficons%3Fi%3Dts&name=1&owner=1&pattern=Solid&pulls=1&stargazers=1&theme=Auto)
22

3-
Leetcode Journal is a robust platform designed to help developers track, organize, and analyze their problem-solving journey on LeetCode. Whether you're preparing for coding interviews or sharpening your skills, Leetcode Journal ensures an intuitive and efficient experience.
3+
# [Leetcode Journal](https://leetcode-journal.vercel.app/)
4+
5+
**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.
46

57
## Project Overview
68

7-
Leetcode Journal is built to address the need for systematic tracking and review of LeetCode solutions. This platform is perfect for developers who want to:
8-
- Save and organize their solutions.
9-
- Monitor progress over time.
10-
- Analyze performance and identify improvement areas.
11-
With features like advanced categorization and visual analytics, the platform aims to streamline the learning process for coders of all levels.
9+
<table align="center">
10+
<thead align="center">
11+
<tr border: 2px;>
12+
<td><b>🌟 Stars</b></td>
13+
<td><b>🍴 Forks</b></td>
14+
<td><b>🐛 Issues</b></td>
15+
<td><b>🔔 Open PRs</b></td>
16+
<td><b>🔕 Close PRs</b></td>
17+
</tr>
18+
</thead>
19+
<tbody>
20+
<tr>
21+
<td><img alt="Stars" src="https://img.shields.io/github/stars/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
22+
<td><img alt="Forks" src="https://img.shields.io/github/forks/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
23+
<td><img alt="Issues" src="https://img.shields.io/github/issues/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
24+
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/yashksaini-coder/Leetcode-Journal?style=flat&logo=github"/></td>
25+
<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>
26+
</tr>
27+
</tbody>
28+
</table>
1229

1330
## Key Features
1431

1532
Leetcode Journal offers the following key features:
1633

17-
- **📝 Save Solutions:** Store and retrieve your LeetCode solutions effortlessly.
34+
- **📝 AI Agent:** An AI Agent that is capable of solving and providing assistance to the developers to help them solve leetcode problems
1835
- **🗂️ Categorize Problems:** Tag problems by difficulty, topic, or category for better organization.
1936
- **📈 Track Progress:** Visualize your journey with detailed progress tracking.
2037
- **📊 Performance Analytics:** Leverage charts and insights to discover patterns in your performance.
@@ -23,102 +40,109 @@ Leetcode Journal offers the following key features:
2340

2441
Leetcode Journal leverages cutting-edge technologies to deliver a seamless user experience:
2542

26-
- **Frontend:** React.js with external UI libraries for modern, responsive design.
27-
- **State Management:** Context API or Redux for efficient data handling.
28-
- **Backend:** Django 3.0 for scalable and secure APIs.
29-
- **Database:** PostgreSQL for reliable and structured data storage.
30-
- **Visualization:** Chart.js for interactive data insights and progress monitoring.
31-
- **Hosting:** Vercel for a fast, optimized live application experience.
43+
| Frontend | ![Next.js](https://skillicons.dev/icons?i=nextjs) | ![TailwindCSS](https://skillicons.dev/icons?i=tailwind) | ![HTML](https://skillicons.dev/icons?i=html) |
44+
|----------|---------|----------|------------|
45+
| Backend | ![Node.js](https://skillicons.dev/icons?i=nodejs) | ![Express.js](https://skillicons.dev/icons?i=express) | ![Supabase](https://skillicons.dev/icons?i=supabase) |
46+
| Database | ![Supabase](https://skillicons.dev/icons?i=supabase) | ![Prisma](https://skillicons.dev/icons?i=prisma) | ![GraphQL](https://skillicons.dev/icons?i=graphql) |
47+
| Deployment | ![Vercel](https://skillicons.dev/icons?i=vercel) | ![Git](https://skillicons.dev/icons?i=git) | ![GitHub](https://skillicons.dev/icons?i=github) |
48+
49+
50+
### How can you Contrbitute to this Project?
51+
52+
#### 1. Fork the Repository
3253

33-
### Setup
54+
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.
3455

35-
#### 1. Clone the Repository
56+
#### 2. Clone the Repository
3657
```bash
37-
git clone https://github.com/your-username/leetcode-journal.git
58+
git clone https://github.com/your-username/leetcode-journal
3859

3960
# Navigate to the project directory
4061
cd leetcode-journal
4162
```
4263

43-
#### 2. Install Dependencies
64+
#### 3. Install Dependencies
4465
```bash
4566
npm install
4667
```
47-
#### 3. Set Up Supabase
68+
69+
#### 4. Set Up Supabase
4870

4971
- Go to the [Supabase](https://supabase.io/) website and create an account.
5072
- Create a new project in Supabase.
5173
- Navigate to the API section and create a new API key.
5274
- Copy the API key and the URL of your Supabase project.
5375

54-
#### 4. Set Up Environment Variables
55-
- Create a new file named `.env` in the `client` directory.
76+
#### %. Set Up Environment Variables
77+
- Create a new file named `.env` in the root directory of the project.
5678
- Add the following environment variables to the file:
5779
```bash
5880
NEXT_PUBLIC_SUPABASE_URL = your-supabase-url
5981
NEXT_PUBLIC_SUPABASE_ANON_KEY = your-anon-key
6082
DATABASE_URL = your-database-url
6183
```
6284

63-
#### 4. Start the Application
85+
#### 6. Start the Application
6486
```bash
6587
# Start the application
6688
npm run dev
6789
```
6890

69-
#### 5. Open the app in your browser
91+
#### 7. Open the app in your browser
7092
You should now be able to access the application at [http://localhost:3000](http://localhost:3000)
7193

7294
## Contributing
95+
We welcome contributions from the community! To get started, you can follow the steps below:
96+
97+
#### 7. Create a New Branch
7398

74-
We welcome contributions! Follow these steps to get started:
75-
```bash
76-
# Click the "Fork" button at the top-right of the repository page to create a copy in your GitHub account.
77-
```
78-
```bash
79-
# Clone the forked repository to your local machine
80-
git clone https://github.com/yashksaini-coder/leetcode-journal.git
81-
```
82-
```bash
83-
# Navigate into the project directory
84-
cd leetcode-journal
85-
```
86-
```bash
87-
#install dependencies
88-
npm install
89-
```
9099
```bash
91100
# Create a new branch for your feature or fix
92101
git checkout -b feature/your-feature-name
93102
```
103+
104+
#### 8. Make sure your changes adhere to the project standards and structure. Stage all changes
105+
94106
```bash
95-
# Make Your Changes
96-
Make sure your changes adhere to the project standards and structure.
97-
# Stage all changes
98107
git add .
99108
```
109+
#### 9. Commit your Changes, with a descriptive message
110+
100111
```bash
101-
# Commit the changes with a descriptive message
102112
git commit -m "Description of the feature or fix"
103113
```
114+
#### 10. Push your Changes into the branch to your forked repository
115+
104116
```bash
105117
# Push your branch to your forked repository
106118
git push origin feature/your-feature-name
107119
```
108-
```bash
109-
# Go to the original repository on GitHub and open a new Pull Request
110-
# Provide a clear description of your changes in the Pull Request.
111-
```
112120

113-
## Contributors
114-
We are grateful to our contributors!
115-
Below is a list of all the amazing contributors who have helped make this project better:
121+
#### 11. Create a Pull Request
122+
123+
- Go to the original repository on GitHub and open a new Pull Request
124+
- Provide a clear description of your changes in the Pull Request.
125+
126+
#### 12. Wait for Review
127+
128+
- Once you have opened a Pull Request, the maintainers will review your changes and provide feedback.
129+
130+
## ✨ Contributors
131+
132+
All Thanks to our contributors 💙
133+
134+
[![GitHub Contributors](https://contrib.rocks/image?repo=yashksaini-coder/Leetcode-Journal)](https://github.com/yashksaini-coder/Leetcode-Journal/graphs/contributors)
135+
136+
<img src="https://www.animatedimages.org/data/media/562/animated-line-image-0184.gif" width="1920" />
137+
138+
## Stargazers ❤️
139+
140+
<div align='left'>
116141

117-
<p align="center">
118-
<img src="https://contrib.rocks/image?repo=yashksaini-coder/leetcode-journal"/>
119-
</p>
142+
[![Stargazers repo roster for @yashksaini-coder/leetcode-journal](https://reporoster.com/stars/yashksaini-coder/leetcode-journal)](https://github.com/yashksaini-coder/leetcode-journal/stargazers)
120143

144+
</div>
121145

122-
*Connect with me on GitHub: [yashksaini-coder](https://github.com/yashksaini-coder)*
146+
## Forkers ❤️
123147

124-
*Explore the live application: [Leetcode Journal Live](https://leetcode-journal.vercel.app/)*
148+
[![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)

0 commit comments

Comments
 (0)