DEVELOPING.md

Developing

Local development

1. Fork https://github.com/adamghill/django-unicorn`
2. git clone your forked repository
3. cd django-unicorn
4. poetry install -E minify -E docs
5. poetry run python example/manage.py migrate
6. poetry run python example/manage.py runserver localhost:8000
7. Go to localhost:8000 in your browser

To install in another project

1. Download the repo to your local
2. pip install -e ../django-unicorn from inside the other project's virtualenv or add django-unicorn = { path="../django-unicorn", develop=true } to the other project's pyproject.toml

Build Sphinx documentation

1. poetry run sphinx-autobuild -W docs/source docs/build

Run unit tests on local environment

1. Python: poetry run pytest
2. JavaScript: npm run test

Run Python/Django matrix unit tests

1. Install act
2. act -W .github/workflows/python.yml -j test

Minify JavaScript

1. npm install
2. npm run build

Bump version

1. Update changelog.md
2. Update package.json
3. poetry version major|minor|patch
4. Run all build processes: poe build
5. Commit/tag/push version bump
6. poe publish
7. Make sure test package can be installed as expected (https://test.pypi.org/project/django-unicorn/)
8. Make sure live package can be installed as expected (https://pypi.org/project/django-unicorn/)
9. Create GitHub release and add changelog there
10. Update django-unicorn.com's version of django-unicorn