Skip to content

Commit f00e7f4

Browse files
Pritam-ReddyPritam-Reddy
authored
Update README.md (#4)
1 parent 843ee03 commit f00e7f4

File tree

1 file changed

+131
-19
lines changed

1 file changed

+131
-19
lines changed

‎README.md

+131-19
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,146 @@
1-
🚀 **Introducing Leetcode Journal** 🚀
1+
# Leetcode Journal 🚀
22

3-
I'm excited to share [Leetcode Journal](https://github.com/yashksaini-coder/Leetcode-Journal), a project designed to help developers track, organize, and review their Leetcode solutions through an intuitive interface.
3+
Your ultimate companion for mastering LeetCode!
44

5-
**Key Features:**
5+
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.
66

7-
- 📝 **Save Solutions:** Easily store your Leetcode solutions for future reference.
8-
- 🗂️ **Categorize Problems:** Organize problems by categories to streamline your study sessions.
9-
- 📈 **Monitor Progress:** Keep track of your problem-solving journey over time.
10-
- 📊 **Analyze Performance:** Gain insights into your strengths and areas for improvement.
7+
## Table of Contents
118

12-
**Why Contribute?**
9+
- [Project Overview](#project-overview)
10+
- [Key Features](#key-features)
11+
- [Tech Stack](#tech-stack)
12+
- [Installation](#installation)
13+
- [Usage](#usage)
14+
- [Contributing](#contributing)
1315

14-
Leetcode Journal serves as both a personal learning tool and a showcase of problem-solving skills. By contributing, you can:
16+
## Project Overview
1517

16-
- 🤝 **Collaborate:** Work with a community of like-minded developers.
17-
- 💡 **Innovate:** Bring new ideas to enhance the tool's functionality.
18-
- 🌟 **Grow:** Develop your skills and enrich your open-source portfolio.
18+
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:
19+
- Save and organize their solutions.
20+
- Monitor progress over time.
21+
- Analyze performance and identify improvement areas.
22+
With features like advanced categorization and visual analytics, the platform aims to streamline the learning process for coders of all levels.
1923

20-
**Get Started:**
24+
## Key Features
2125

22-
1. **Explore the Repository:** Check out the project on GitHub: [Leetcode Journal](https://github.com/yashksaini-coder/Leetcode-Journal).
23-
2. **Read the Documentation:** Understand the project's structure and guidelines.
24-
3. **Contribute:** Pick an issue or suggest improvements. Your input is invaluable!
26+
Leetcode Journal offers the following key features:
2527

26-
Let's build something amazing together! 🌐
28+
- **📝 Save Solutions:** Store and retrieve your LeetCode solutions effortlessly.
29+
- **🗂️ Categorize Problems:** Tag problems by difficulty, topic, or category for better organization.
30+
- **📈 Track Progress:** Visualize your journey with detailed progress tracking.
31+
- **📊 Performance Analytics:** Leverage charts and insights to discover patterns in your performance.
2732

28-
Happy coding! 💻
33+
## Tech Stack
34+
35+
Leetcode Journal leverages cutting-edge technologies to deliver a seamless user experience:
36+
37+
- **Frontend:** React.js with external UI libraries for modern, responsive design.
38+
- **State Management:** Context API or Redux for efficient data handling.
39+
- **Backend:** Django 3.0 for scalable and secure APIs.
40+
- **Database:** PostgreSQL for reliable and structured data storage.
41+
- **Visualization:** Chart.js for interactive data insights and progress monitoring.
42+
- **Hosting:** Vercel for a fast, optimized live application experience.
43+
44+
## Installation
45+
46+
### Prerequisites
47+
48+
Ensure you have the following tools installed:
49+
50+
- [Node.js](https://nodejs.org/) (v16.x or higher)
51+
- [npm](https://www.npmjs.com/) (v6.x or higher) or yarn (v1.x or higher)
52+
- [Python](https://www.python.org/) (v3.x or higher)
53+
- [PostgreSQL](https://www.postgresql.org/) (v14.x or higher)
54+
Python 3.x
55+
PostgreSQL
56+
57+
### Setup
58+
59+
#### 1. Clone the Repository
60+
```bash
61+
git clone https://github.com/your-username/leetcode-journal.git
62+
63+
# Navigate to the project directory
64+
cd leetcode-journal
65+
```
66+
67+
#### 2. Install Dependencies
68+
```bash
69+
# Install backend dependencies
70+
pip install -r requirements.txt
71+
72+
# Install frontend dependencies
73+
cd client
74+
npm install
75+
```
76+
#### 3. Set Up Database
77+
78+
- Configure your PostgreSQL database in the backend settings.
79+
80+
#### 4. Start the Application
81+
```bash
82+
# Start the backend
83+
python manage.py runserver
84+
85+
# Start the frontend
86+
cd client
87+
npm start
88+
```
89+
#### 5. Open the app in your browser
90+
You should now be able to access the application at [http://localhost:3000](http://localhost:3000)
91+
92+
## Usage
93+
94+
- **Login/Sign Up:** Access your personalized dashboard.
95+
- **Save Solutions:** Add your solutions and tag them by category.
96+
- **Analyze Performance:** Explore your progress using charts and statistics.
97+
- **Categorize Problems:** Organize and retrieve problems effortlessly.
98+
99+
## Contributing
100+
101+
We welcome contributions! Follow these steps to get started:
102+
```bash
103+
# Click the "Fork" button at the top-right of the repository page to create a copy in your GitHub account.
104+
```
105+
```bash
106+
# Clone the forked repository to your local machine
107+
git clone https://github.com/your-username/leetcode-journal.git
108+
```
109+
```bash
110+
# Navigate into the project directory
111+
cd leetcode-journal
112+
```
113+
```bash
114+
#install dependencies
115+
npm install
116+
```
117+
```bash
118+
# Create a new branch for your feature or fix
119+
git checkout -b feature/your-feature-name
120+
```
121+
```bash
122+
# Make Your Changes
123+
Make sure your changes adhere to the project standards and structure.
124+
# Stage all changes
125+
git add .
126+
```
127+
```bash
128+
# Commit the changes with a descriptive message
129+
git commit -m "Description of the feature or fix"
130+
```
131+
```bash
132+
# Push your branch to your forked repository
133+
git push origin feature/your-feature-name
134+
```
135+
```bash
136+
# Go to the original repository on GitHub and open a new Pull Request
137+
# Provide a clear description of your changes in the Pull Request.
138+
```
29139

30140
*Connect with me on GitHub: [yashksaini-coder](https://github.com/yashksaini-coder)*
31141

32142
*Explore the live application: [Leetcode Journal Live](https://leetcode-journal.vercel.app/)*
33143

34-
*Learn more about effective Leetcode practices: [The DEFINITIVE way on how to LeetCode properly](https://www.reddit.com/r/cscareerquestions/comments/sgktuv/the_definitive_way_on_how_to_leetcode_properly/)*
144+
*Learn more about effective Leetcode practices: [The DEFINITIVE way on how to LeetCode properly](https://www.reddit.com/r/cscareerquestions/comments/sgktuv/the_definitive_way_on_how_to_leetcode_properly/)*
145+
146+
<h3 align="center"> Happy Coding ☕️</h3>

0 commit comments

Comments
 (0)