Welcome to the OpenLeetCode Project!
The motivation behind this project is to be able to practice LeetCode problems on a plane without requiring an internet connection (until Starlink ramps up). This project is not intended to replace or replicate leetcode.com.
- OpenLeetCode - An open source version of LeetCode
- Table of Content
- Screenshot
- Build
- Run
- How To Use
- Problems
- Usage
- Note
- Requirements - Additional Requirements for the UI
- Contributing
git clone https://github.com/mbucko/openleetcode
cd openleetcode
.\install --prefix=./installgit clone https://github.com/mbucko/openleetcode
cd openleetcode
.\install --prefix=./install --enable_uigit clone https://github.com/mbucko/openleetcode
cd openleetcode
./install.sh --prefix=./installgit clone https://github.com/mbucko/openleetcode
cd openleetcode
./install.sh --prefix=./install --enable_uidir install/OpenLeetCode
./openleetcode --language cpp --problem TwoSumdir install/OpenLeetCode
./openleetcodeuicd install/OpenLeetCode
./openleetcode.sh --language cpp --problem TwoSumPython works the same way:
cd install/OpenLeetCode
./openleetcode.sh --language python --problem TwoSumIf uv is installed, the script runs inside the project's uv environment and installs its dependencies on first use. Without uv, install the jsonschema package for your Python yourself.
cd install/OpenLeetCode
./openleetcodeui.shIn the UI, ☰ Problems (or Cmd/Ctrl+P) opens the problem list, where you can search and filter by difficulty and by whether you have solved the problem. A problem counts as solved in a language, and the list marks it with ✓, while your solution file holds the code that last passed all its testcases. Editing the code or resetting it removes the ✓ until it passes again. The selector next to ▶ Run switches between C++ and Python, and ⚙ changes the theme (dark blue, dark grey or light). Reset, above the code, replaces your code with the starter code after asking you to confirm. Cmd/Ctrl+S saves, Cmd/Ctrl+R runs the tests and Cmd/Ctrl+T runs a custom testcase.
Test results show whether your solution was accepted and one green or red box per testcase; select a box to see that testcase's input, your output and the expected output. If your code crashes or raises an error, the result shows the line in your solution where it happened.
NOTE: The UI has been used on macOS; Linux is yet to be tested.
After the build succeeds, the following directory structure will be generated:
- problems
- NumberOfIslands
- cpp
- solution.cpp
- ...
- python
- solution.py
- ...
- testcases
- TestCase1.test
- TestCase2.test
- ...
- description.md
- metadata.json
- cpp
- TwoSum
- ..
- NumberOfIslands
- launguage
- cpp
- python
Just like for LeetCode, you have one file per language where you solve the problem: problems/TwoSum/cpp/solution.cpp for C++ and problems/TwoSum/python/solution.py for Python. Reinstalling keeps these files, so your solutions are not overwritten. The starter code is kept next to them as solution_starter.cpp and solution_starter.py, which the UI's Reset button restores. To add new test cases, you can create a file in the problems/TwoSum/testcases/ directory with the file extension .test, and the solution will automatically be tested against it. Test files whose name starts with _ only run when requested by name with --testcase; the UI uses this for its custom testcase.
Each problem is described in the description.md file location in the problem's directory. For example problems/TwoSum/description.md. The problem's LeetCode number and difficulty are in its metadata.json.
The format of the .test files are as follows:
<arg1>
<arg2>
<expected results>
The supported types are: integral type, a string, TreeNode structure, boolean or an array. For example:
["1", "2", "4"]
8.0
[0, 0]
A ThreeNode structure is represented in an array-based structure. For example an array representation [1, 2, null, null, 3] results to the following structure:
1
/ \
2 3
OpenLeetCode ships with over a hundred problems, including variations of LeetCode problems #1 through #100. Every problem has both a C++ and a Python version.
To see the full list, run:
cd install/OpenLeetCode
./openleetcode.sh --list-problemsThe problem names are automatically extracted from the problems folder.
$ ./openleetcode.sh --help
usage: openleetcode.py [-h] [--language {cpp,python}] [--list-problems]
[--list-testcases] [--problem problem_name]
[--problem_builds_dir dir] [--run-expected-tests]
[--testcase testcase_name] [--verbose]
OpenLeetCode problem builder. This script builds and tests a LeetCode-like
problems locally. Currently, it supports the C++ and Python languages, but it
can be extended to support other languages.
options:
-h, --help show this help message and exit
--language {cpp,python}, -l {cpp,python}
The programming language.
--list-problems List problems.
--list-testcases List testcases for a problem specified with '--
problem' option.
--problem problem_name, -p problem_name
Name of the problem to build and test. Default:
TwoSum. Use --list-problems to list all problems.
--problem_builds_dir dir, -d dir
Specifies the directory with the problems. Typically,
this is './problem_builds'. If not provided, the
script defaults to './problem_builds' in the same
directory as the executable.
--run-expected-tests, -r
Run the expected solution. Default: False.
--testcase testcase_name, -t testcase_name
Name of the testcase to run. '--testcase All' will run
all testcases. Default: All.
--verbose, -v Print verbose output
Both the CLI and the UI support C++ and Python.
This project requires the following to run:
- Python
- CMake 3.12
- Git
- uv (recommended), or the
jsonschemaPython package
- npm
Feel free to contribute with code, test cases, or even code reviews.
For a more in-depth guide on how to contribute and information about the inner workings of OpenLeetCode, please refer to the Docs. You can also join our Discord chat if you have any questions about the usage or development.
