Contributing

Starting from the repo root you might want to create a new virtual environment:

make venv

And activate it:

source .venv/bin/activate

Then, install all project dependencies into the virtual enviroment just created:

make install-deps

This task will install more dependencies than pyproject.toml, like pytest. Speaking of tests, now it is a good idea to run them, to check if everything in your system works as intended:

make test

Note: tests use an in-memory sqlite database filled with /tests/test-data.sql so they are independent from actual Coldsweat database.

The next step is to create a sample user named alice@example.com, with password password1234 and fill the development sqlite database with some sample feeds:

make setup

For the web UI to work the SCSS/JS assets need to be compiled first. We use Parcel to build the files. Install node and npm and then run:

npm ci && make build-assets

This will put app.css and app.js into the static folder.

Finally, run the Flask development web server to access the web UI:

make run-debug

The web server will automatically reload when it detects that a project file is changed.

Now you are ready to tinker with the code!