Skip to content

Commit 9482d53

Browse files
committed
docs: update README file.
1 parent b4168a0 commit 9482d53

1 file changed

Lines changed: 208 additions & 66 deletions

File tree

README.md

Lines changed: 208 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,215 @@
1+
<div align="center">
2+
13
# 🚀 LeetCode Sync
24

3-
Automatically synchronize accepted LeetCode submissions to GitHub.
5+
Automatically synchronize accepted LeetCode solutions to GitHub.
6+
7+
Download solutions • Generate metadata • Update README • Push to GitHub automatically
8+
9+
Built with ❤️ in Python
10+
11+
</div>
12+
13+
## Badges
414

5-
---
15+
![Python](https://img.shields.io/badge/Python-3.13-blue)
16+
![Tests](https://github.com/arnav-on-code/LEETCODE_SYNC/actions/workflows/tests.yml/badge.svg)
17+
![Lint](https://github.com/arnav-on-code/LEETCODE_SYNC/actions/workflows/lint.yml/badge.svg)
18+
![Sync](https://github.com/arnav-on-code/LEETCODE_SYNC/actions/workflows/sync.yml/badge.svg)
19+
![License](https://img.shields.io/github/license/arnav-on-code/LEETCODE_SYNC)
620

7-
## 📈 Progress
21+
22+
## ✨ Features
23+
24+
- ✅ Automatic LeetCode authentication
25+
- ✅ Fetch recent accepted submissions
26+
- ✅ Download source code
27+
- ✅ Save metadata
28+
- ✅ Git automation
29+
- ✅ README generation
30+
- ✅ Statistics tracking
31+
- ✅ GitHub Actions automation
32+
- ✅ Unit tested
33+
34+
35+
## 🏗️ Architecture
836

937
```text
10-
████████████░░░░░░░░░░░░░░░░░░
11-
12-
Solved: 121 / 300 Problems
13-
14-
📊 Statistics
15-
Difficulty Solved
16-
🟢 Easy 63
17-
🟡 Medium 52
18-
🔴 Hard 6
19-
Total 121
20-
🔥 Latest Accepted Problem
21-
22-
23-
| Field | Value |
24-
|------|------|
25-
| Problem ID | 11 |
26-
| Title | Container With Most Water |
27-
| Language | Python3 |
28-
| Runtime | 64 ms |
29-
| Memory | 29.5 MB |
30-
31-
32-
💻 Languages Used
33-
34-
- **Python3** : 1
35-
36-
✨ Features
37-
Automatic LeetCode synchronization
38-
Automatic Git commits
39-
Automatic GitHub push
40-
Metadata generation
41-
README generation
42-
GitHub Actions support
43-
Unit tests
44-
📂 Repository Structure
45-
storage/
46-
└── solutions/
47-
├── 0011_Container_With_Most_Water/
48-
│ ├── solution.py
49-
│ └── metadata.json
50-
└── ....
51-
⚙️ Workflow
5238
LeetCode
53-
54-
55-
API
56-
57-
58-
Downloader
59-
60-
61-
Statistics
62-
63-
64-
README Generator
65-
66-
67-
Git
68-
69-
70-
GitHub
71-
⏰ Last Sync
72-
73-
2026-07-02T09:32:10.126675
39+
40+
41+
Authentication
42+
43+
44+
API Client
45+
46+
47+
Parser
48+
49+
50+
Downloader
51+
52+
53+
Statistics
54+
55+
56+
README Generator
57+
58+
59+
Git Manager
60+
61+
62+
GitHub
63+
```
64+
65+
## ⚙️ Installation
66+
67+
```bash
68+
git clone https://github.com/arnav-on-code/LEETCODE_SYNC.git
69+
70+
cd LEETCODE_SYNC
71+
72+
python -m venv myenv
73+
74+
pip install -r requirements.txt
75+
```
76+
77+
## 🔐 Environment Variables
78+
79+
Create a `.env`
80+
81+
```text
82+
LEETCODE_SESSION=
83+
84+
CSRF_TOKEN=
85+
86+
LEETCODE_USERNAME=
87+
88+
GITHUB_USER=
89+
90+
GITHUB_EMAIL=
91+
```
92+
93+
## 🚀 Usage
94+
95+
Run manually
96+
97+
```bash
98+
python main.py
99+
```
100+
101+
Run tests
102+
103+
```bash
104+
pytest tests -v
105+
```
106+
107+
Format code
108+
109+
```bash
110+
black .
111+
```
112+
113+
Lint
114+
115+
```bash
116+
flake8 .
117+
```
118+
119+
## 📊 Statistics
120+
121+
Easy
122+
123+
Medium
124+
125+
Hard
126+
127+
Total
128+
129+
Languages
130+
131+
Recent Problems
132+
133+
Latest Accepted
134+
135+
Last Sync
136+
137+
138+
## 📂 Repository Structure
139+
140+
```text
141+
Leetcode_sync
142+
143+
├── .github/
144+
├── config/
145+
├── github_sync/
146+
├── leetcode/
147+
├── storage/
148+
├── sync/
149+
├── tests/
150+
├── utils/
151+
├── README.md
152+
├── requirements.txt
153+
└── main.py
154+
```
155+
156+
## 🧪 Testing
157+
158+
Current Status
159+
160+
- ✅ 23 Unit Tests
161+
- ✅ GitHub Actions
162+
- ✅ Lint Checks
163+
- ✅ Automatic Synchronization
164+
165+
166+
## 🤖 GitHub Actions
167+
168+
Three workflows are configured.
169+
170+
• tests.yml
171+
172+
Runs all unit tests.
173+
174+
• lint.yml
175+
176+
Checks formatting and linting.
177+
178+
• sync.yml
179+
180+
Automatically synchronizes LeetCode submissions every 6 hours.
181+
182+
## 🛣️ Roadmap
183+
184+
- [x] Authentication
185+
186+
- [x] Downloader
187+
188+
- [x] Metadata
189+
190+
- [x] Statistics
191+
192+
- [x] README Generator
193+
194+
- [x] GitHub Actions
195+
196+
- [x] Unit Tests
197+
198+
- [x] README Automation
199+
200+
- [ ] Docker Image
201+
202+
- [ ] Multi-language README
203+
204+
- [ ] PyPI Package
205+
206+
207+
## 📜 License
208+
209+
This project is licensed under the MIT License.
210+
211+
## 📖 About
212+
213+
LeetCode Sync automatically downloads accepted LeetCode solutions, stores them with metadata, updates repository statistics, regenerates the project README, and synchronizes everything to GitHub.
214+
215+
The project is designed with a modular architecture and includes automated testing, CI workflows, and Git integration.

0 commit comments

Comments
 (0)