https://github.com/neo4j-examples/paradise-papers-django
A simple Django web app for searching the Paradise Papers dataset backed by Neo4j
https://github.com/neo4j-examples/paradise-papers-django
neo4j neomodel paradise-papers
Last synced: about 2 months ago
JSON representation
A simple Django web app for searching the Paradise Papers dataset backed by Neo4j
- Host: GitHub
- URL: https://github.com/neo4j-examples/paradise-papers-django
- Owner: neo4j-examples
- License: apache-2.0
- Created: 2017-12-08T20:20:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T17:03:40.000Z (9 months ago)
- Last Synced: 2025-05-08T01:43:20.623Z (about 2 months ago)
- Topics: neo4j, neomodel, paradise-papers
- Language: Python
- Homepage:
- Size: 886 KB
- Stars: 81
- Watchers: 13
- Forks: 30
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# paradise-papers-django
A simple Django web app for searching the Paradise Papers dataset backed by Neo4j
[Welcome to Paradise Paper Search App’s Django + Neomodel Tutorial!](https://neo4j-examples.github.io/paradise-papers-django/)
# Requirements
- Python 3.7+
- Django 2.2+
- neo4j 5.x, 4.4
- django-neomodel 0.1.1
# Quickstart
First create an [sandbox database](https://sandbox.neo4j.com/), make sure to select **Paradise Papers by ICIJ** under **Pre-Built Data**, copy the credentials: username, password and bolt URL, you are going to need that later.
``` bash
# Clone this repository
git clone https://github.com/neo4j-examples/paradise-papers-django
# Go into the repository
cd paradise-papers-django
# active your [virtual environment](https://docs.python.org/3/tutorial/venv.html) and install your dependencies
cd paradise_papers_search
python -m venv venv
source venv/bin/activate
pip install -r ../requirements.txt
# Run the app
export DATABASE_URL=bolt://:@
:7687 # update with the credentials from your sandbox database.
python manage.py runserver --settings=paradise_papers_search.settings.dev
```
# Registering Models in the Admin
In `paradise_papers_search/fetch_api/admin`, add the models you would like to explore using the admin:
```python
from django.contrib import admin as dj_admin
from django_neomodel import admin as neo_admin
from .models import Entity
class EntityAdmin(dj_admin.ModelAdmin):
list_display = ("name",)
neo_admin.register(Entity, EntityAdmin)
```
Create the admin superuser:
```
./manage.py migrate
./manage.py createsuperuser
```
Run the app!
```
python manage.py runserver --settings=paradise_papers_search.settings.dev
```
Start searching at http://127.0.0.1:8000/
View the admin at http://127.0.0.1:8000/admin
While testing locally you may want to do `export ALLOWED_HOST=*`
# Quick Heroku Deployment with Neo4j Sandbox
Create an sandbox database, make sure to select `Paradise Papers by ICIJ` under Pre-Built Data.
copy the database's username, password, and bolt URL.
Create a Heroku app, (for example, `paradise-papers`)
Go to the app's settings and add the following config vars:
`ALLOWED_HOST` : `paradise-papers.herokuapp.com`
`DATABASE_URL`: the credentials from your sandbox database in the following format `bolt://user:password@ip:port`
Clone the repository and navigate into the directory, add Heroku as a remote, and push to Heroku:
```
git clone [email protected]:neo4j-examples/paradise-papers-django.git
cd paradise-papers-django
git remote add heroku https://git.heroku.com/paradise-papers.git
git push heroku master
```
View your app at the URL you specified earlier.
_________
_________
_________
_________
