git submodule update --init --recursive
cp .env.example .env
make up
Add to .env to automatically start vite dev server:-
DJANGO_UMIN_VITE_DEV_MODE=True
DJANGO_UMIN_VITE_HMR_PORT=5173
Or run uv run manage.py vite_build to build it manually, such as for production deploy.
In separate terminal, run:-
make dev
make run
IMPORTANT
Run ./rename.sh myapp yourappname before running your first make dev as that will run initial django migrations and AUTH_USER_MODEL is set by default to myapp_user.User. You should change it to your own custom user models.
Login to the dashboard at /dashboard/ and using email admin@myapp.co and password picard data.
Vite dev server run on different port than the django dev server and unless you set it to public, it need to be authenticated first. You will need to open the css or js file directly first so that github will authenticate it. After that it should work as expected.
The default project name is myapp and is used throughout the codebase for db name, settings and file/directory name. Run the script rename.sh to change this to your preferred project name.