Skip to content
This repository has been archived by the owner on Nov 8, 2021. It is now read-only.

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
csae8092 committed Jan 12, 2021
1 parent 04f1cfc commit 3462610
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ __pycache__/

# sqlite
/*.sqlite3
/*.sqlite3-journal

# test coverage
.coverage
Expand Down Expand Up @@ -42,3 +43,8 @@ dev_secret.py
/arche/data/fileList.json
/myenv
node_modules


# other things

temp
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,29 @@ As the name suggests, this is a basic Django project. The idea of this base proj
* activate virtual env, e.g. `source myenv/bin/activate`
* install needed packages `pip install -r requirements.txt`

## Start

* apply migrations `python manage.py migrate --settings=djangobaseproject.settings.dev`
* start dev-server `python manage.py runserver ---settings=djangobaseproject.settings.dev`
* open http://127.0.0.1:8000/


# included packages

## [acdh-django-browsing](https://github.com/acdh-oeaw/acdh-django-browsing)

Django-App providing some useful things to create browsing views


## [acdh-django-vocabs](https://github.com/acdh-oeaw/acdh-django-vocabs)

Curate controlled vocabularies as SKOS

## [acdh-django-geonames](https://github.com/acdh-oeaw/acdh-django-geonames)

A django package providing models and views for Geoname Places

* populate vocabs with geoname-feature codes
* `python manage.py import_ftc --lang=en--settings=djangobaseproject.settings.dev`
* populate db with geoname-places of a given country:
* `python manage.py import_places ..--country_code=YU--settings=djangobaseproject.settings.dev`
1 change: 1 addition & 0 deletions djangobaseproject/settings/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
'browsing',
'vocabs',
'infos',
'gn_places',
]

CRISPY_TEMPLATE_PACK = "bootstrap4"
Expand Down
4 changes: 4 additions & 0 deletions djangobaseproject/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
url(r'^info/', include('infos.urls', namespace='info')),
url(r'^vocabs/', include('vocabs.urls', namespace='vocabs')),
url(r'^vocabs-ac/', include('vocabs.dal_urls', namespace='vocabs-ac')),
url(
r'^gn-places-ac/',
include('gn_places.dal_urls', namespace='gn_places-ac')
),
url(r'^', include('webpage.urls', namespace='webpage')),
]

Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
acdh-django-vocabs>=0.1.3
acdh-django-geonames>=0.1.1
Django>=3.1
requests>=2.25
gunicorn>=20.0.4

0 comments on commit 3462610

Please sign in to comment.