Metadata-Version: 2.1
Name: django-story-map
Version: 0.2.1
Summary: A django app to create/edit/publish story maps using https://storymap.knightlab.com/
Home-page: https://github.com/acdh-oeaw/django-story-map
Author: Peter Andorfer
Author-email: peter.andorfer@oeaw.ac.at
License: MIT
Keywords: django-story-map
Platform: UNKNOWN
Description-Content-Type: text/markdown

[![Test](https://github.com/acdh-oeaw/django-story-map/actions/workflows/test.yml/badge.svg)](https://github.com/acdh-oeaw/django-story-map/actions/workflows/test.yml)
[![flake8 Lint](https://github.com/acdh-oeaw/django-story-map/actions/workflows/lint.yml/badge.svg)](https://github.com/acdh-oeaw/django-story-map/actions/workflows/lint.yml)
[![codecov](https://codecov.io/gh/acdh-oeaw/django-story-map/branch/master/graph/badge.svg?token=EK3LO3URJK)](https://codecov.io/gh/acdh-oeaw/django-story-map)
# Django Story Map

A django app to create/edit/publish story maps using https://storymap.knightlab.com/

## install

* clone the repo
* change into the project's root directory e.g. `cd django-story-map`
* create a virtual environment e.g. `virutalenv env` and activate it `source env/bin/activate`
* install required packages `pip install -r requirements_dev.txt`
* run migrations `python manage.py migrate`
* start the dev sever `python manage.py runserver`
* go to [http://127.0.0.1:8000](http://127.0.0.1:8000/) and check if everything works


## Docker

At the ACDH-CH we use a centralized database-server. So instead of spawning a database for each service our services are talking to a database on this centralized db-server. This setup is reflected in the dockerized setting as well, meaning it expects an already existing database (either on your host, e.g. accessible via 'localhost' or some remote one)

### building the image

* `docker build -t dsm:latest .`
* `docker build -t dsm:latest --no-cache .`


### running the image

To run the image you should provide an `.env` file to pass in needed environment variables; see example below:

* `docker run -it -p 8020:8020 --rm --env-file env.default --name dsm dsm:latest`

-----

This project was bootstraped by [djangobase-cookiecutter](https://github.com/acdh-oeaw/djangobase-cookiecutter)

