Quick Start¤

We have spent and still spend a lot of time on making Easysort easy to use. In just 10 minutes, Easysort should be running on your machine.

1. Setup your development environment¤

We used the following tools. Make sure you have all of them installed.

Clone our repo:

git clone --recurse-submodules https://github.com/EasySort/easysort

Setup uv and run our tests:

# This will install all the dependencies and setup the virtual environment
uv sync
# Run the tests to make sure everything is working
just test

Notice: If you wish to run any specific file, use uv run <file> as opposed to python <file>.

You can start the UI and API locally by running:

just dev