Merge pull request #26 from peopledoc/demo-migrations-db

Added documentation to install and bootstrap the demo app

Author: brunobord

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 # master (unreleased)
 
-- Changing Github Organization from ``novafloss`` to ``peopledoc`` (#24)
+- Changing Github Organization from ``novafloss`` to ``peopledoc`` (#24),
+- Added documentation to install and bootstrap the demo app.
 
 ## 1.3.0 (2017-09-14)
 

demo/.gitignore

@@ -0,0 +1 @@
+demo_chunkator.db

demo/README.md

@@ -0,0 +1,26 @@
+# Django Chunkator demo app
+
+this demo app is mainly used for running tests, but you may want to install it for manual testing
+
+## Install
+
+* (create and) activate a virtualenv (using your favorite Python version)
+* from this virtualenv, install your required Django version. e.g.: ``pip install Django==1.11``
+* from this directory, install the demo app: ``pip install -e ./``
+
+
+### Set up the database
+
+This will create the SQLite database and sync its models:
+
+```sh
+django-admin migrate --settings=demo_chunkator.settings
+```
+
+### Feed the "bookstore"
+
+We're providing a sample ``book.json`` fixture, to load into your DB like this:
+
+```sh
+django-admin loaddata --settings=demo_chunkator.settings book.json
+```

demo/demo_chunkator/migrations/0001_initial.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11 on 2018-05-14 04:22
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Book',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(max_length=200)),
+                ('author', models.CharField(max_length=200)),
+            ],
+            options={
+                'ordering': ['title'],
+            },
+        ),
+        migrations.CreateModel(
+            name='User',
+            fields=[
+                ('uuid', models.UUIDField(default=uuid.uuid4, primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=100)),
+            ],
+            options={
+                'ordering': ['name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='Cover',
+            fields=[
+                ('book', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='demo_chunkator.Book')),
+                ('code', models.CharField(max_length=20)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Profile',
+            fields=[
+                ('user', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='demo_chunkator.User')),
+                ('avatar', models.CharField(max_length=100)),
+            ],
+        ),
+    ]

demo/demo_chunkator/migrations/__init__.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+from os.path import abspath, dirname, join
+_current_dir = dirname(abspath(__file__))
 
 INSTALLED_APPS = [
     'demo_chunkator',
@@ -8,7 +10,7 @@
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': 'demo_chunkator.db',
+        'NAME': join(_current_dir, 'demo_chunkator.db'),
     }
 }