diff --git a/README.md b/README.md index b6a75d6131b2ea7f5c878d42c164cc1d13dd7e91..3fbc74e666a09353997a6c844d3eece1c682591c 100644 --- a/README.md +++ b/README.md @@ -67,9 +67,19 @@ Arkindex splits up image URLs in their image server and the image path. For exam LOCAL_IMAGESERVER_ID = 999 ``` +Here is how to quickly create the ImageServer using the shell: + +``` +backend/arkindex$ ./manage.py shell +>>> from arkindex.images.models import ImageServer +>>> ImageServer.objects.create(id=1, display_name='local', url='https://ark.localhost/iiif') +``` + +Note that this local server will only work inside Docker. + ## Usage -###Â Makefile +### Makefile At the root of the repository is a Makefile that provides commands for common operations: @@ -107,7 +117,7 @@ Once your code appears to be working on a local server, a few checks have to be Use `./manage.py test module_name` to perform tests on a single module, if you wish to spend less time waiting for all tests to complete. * **Code linting:** Type `flake8` inside the `backend/arkindex` directory. Our Flake8 settings should allow 120 characters per line instead of PEP8's 80. -##Â Debugging tools +## Debugging tools Run `pip install ipython django-debug-toolbar django_extensions` to install all the available optional dev tools for the backend.