diff --git a/README.rst b/README.rst index f017731eb7f58921019838c921bccbf49b802660..a44d5b00eaf23ff97799fb6a37e6e1f32e7e74b4 100644 --- a/README.rst +++ b/README.rst @@ -25,15 +25,25 @@ Then, you can setup the database:: $ docker compose run django ./manage.py migrate -And load the fixtures:: +You can the load all the fixtures. This loads data for the authentication +(users, groups and permissions) and for the program app (categories, funding +categories, hosts, languages, music focus, recurrence rules, shows, topics and +types). + +This provides enough data to get started:: $ docker compose run django ./manage.py loaddata fixtures/*/*.json -Or, if you prefer, you can just create a super user after setting up the -database:: +Alternatively, if you prefer, you can just create a super user after setting up +the database:: $ docker compose run django python manage.py createsuperuser +The only required fixtures are the recurrence rules, these are needed to create +schedules:: + + $ docker compose run django ./manage.py loaddata fixtures/program/rrule.json + Then, you can create a RSA Key and the clients for `dashboard` and `tank`:: $ docker compose run django ./manage.py creatersakey @@ -65,7 +75,6 @@ venv If you really don't want to use Docker, you can install `steering` using a virtual environment. - Create and activate a virtual environment:: $ python3.9 -m venv venv @@ -80,7 +89,6 @@ Then, you can setup the database:: (venv) $ ./manage.py migrate - And load the fixtures:: (venv) $ ./manage.py loaddata fixtures/*/*.json @@ -90,6 +98,11 @@ database:: (venv) $ manage.py createsuperuser +The only required fixtures are the recurrence rules, these are needed to create +schedules:: + + $ docker compose run django ./manage.py loaddata fixtures/program/rrule.json + Then, you can create a RSA Key and the clients for `dashboard` and `tank`:: (venv) $ ./manage.py creatersakey @@ -99,3 +112,4 @@ Then, you can create a RSA Key and the clients for `dashboard` and `tank`:: Finally, you can start the development server:: (venv) $ ./manage.py runserver +