Skip to content

Commit d8590d7

Browse files
committed
docs: updateREADME.md with objective and plan
1 parent da31f6d commit d8590d7

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# LeetCode Sync
2+
3+
A Python-based automation tool that synchronizes accepted LeetCode solutions to GitHub without relying on third-party browser extensions.
4+
5+
## Objective
6+
7+
This project aims to build a secure and customizable alternative to browser extensions by automating the entire workflow—from fetching accepted LeetCode submissions to committing and pushing them to a GitHub repository.
8+
9+
## Planned Features
10+
11+
* Fetch accepted LeetCode submissions
12+
* Download submitted source code
13+
* Organize solutions by problem number and title
14+
* Automatically generate and update a README
15+
* Commit and push new solutions to GitHub
16+
* Scheduled synchronization using GitHub Actions
17+
* Logging and error handling
18+
* Modular and extensible project architecture
19+
* Unit tests for core components
20+
21+
## Project Structure
22+
23+
```text
24+
leetcode-sync/
25+
26+
├── README.md
27+
├── requirements.txt
28+
├── .env.example
29+
├── config.py
30+
├── main.py
31+
32+
├── leetcode/
33+
├── github_sync/
34+
├── storage/
35+
├── logs/
36+
├── tests/
37+
└── .github/
38+
└── workflows/
39+
```
40+
41+
## Tech Stack
42+
43+
* Python
44+
* Git
45+
* GitHub Actions
46+
* Requests
47+
* BeautifulSoup
48+
* GitPython
49+
* python-dotenv
50+
* Pytest
51+
52+
## Project Status
53+
54+
🚧 This project is currently under active development.
55+
56+
The first milestone focuses on setting up the project structure before implementing LeetCode authentication, solution synchronization, Git automation, and scheduled workflows.
57+
58+
## License
59+
60+
This project is intended for educational and personal use.

0 commit comments

Comments
 (0)