Contributing

Install uv

git clone ..
uv venv .venv --python 3.12
source .venv/bin/activate
uv sync --all-extras
pre-commit install --hook-type pre-commit --hook-type pre-push

Tailwind CSS

This project uses django-tailwind to manage CSS. CSS sources are located in the birder/theme/static_src/src/. If you need to edit the CSS follow the below steps:

1. Install node dependencies

   ./manage.py tailwind install
   

2. Configure the enviroment

   export EXTRA_APPS="birder.contrib.hope,django_browser_reload"
   export EXTRA_MIDDLEWARES="django_browser_reload.middleware.BrowserReloadMiddleware,"
   

3. Build the final CSS

   ./manage.py tailwind build
   

   Or you can run the development mode

   ./manage.py tailwind start
   

Run tests

pytests tests

Run local server

./manage.py runserver

Docker compose

Alternatively you can use provided docker compose for development

docker compose up

Alternatively you can use provided docker compose for development

docker compose up