See Usage for instructions on how to use this repository.
- PostgreSQL 16 (or Docker)
- Python 3.13
libtidy-dev(e.g.,apt install libtidy-devorbrew install tidy-html5)
- Clone the repo:
git clone git@github.com:hkhanna/django-base.git - Copy
.env.exampleto.envand make any appropriate changes. - If you have a database running, from within the repo directory, run
make all. - If you do not have a local database running but you do have Docker running, run
make all-docker. - The initial superuser account is
admin@localhostwith passwordadmin.
make runwill load the application atlocalhost:WEB_PORT, whereWEB_PORTis set in your.envfile.- It also runs the
viteserver, which is needed for bundling tailwind as well as any other custom Javascript you need.
- It also runs the
make mypyto run a manual typecheck on the repo.make checkwill run all tests including playwright.make playwrightwill run only E2E tests in headed mode.
pip-outdated <requirements file>for every requirements file to see what's outdated. Fix them all.
- Ensure that there is a
baseremote pointing at the base repo on Github. git fetch basegit merge base/main.
- Push to
origin/mainand it will automatically trigger a deploy.