Skip to content
Snippets Groups Projects
Commit b7781c88 authored by Erwan Rouchet's avatar Erwan Rouchet Committed by Bastien Abadie
Browse files

Add more explicit docs for the local ImageServer

parent c55c4175
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment