From 442998cbb387786e5e3748bb8b34d0396d4be438 Mon Sep 17 00:00:00 2001 From: Adam Charnock Date: Thu, 31 Dec 2015 13:16:23 +0000 Subject: [PATCH] Adding Readme file to cookbook example project --- examples/cookbook/README.md | 64 ++++++++++++++++++++++++++++++ examples/cookbook/requirements.txt | 6 +-- 2 files changed, 67 insertions(+), 3 deletions(-) create mode 100644 examples/cookbook/README.md diff --git a/examples/cookbook/README.md b/examples/cookbook/README.md new file mode 100644 index 00000000..206d97c3 --- /dev/null +++ b/examples/cookbook/README.md @@ -0,0 +1,64 @@ +Cookbook Example Django Project +=============================== + +This example project demos integration between Graphene and Django. +The project contains two apps, one named `ingredients` and another +named `recepies`. + +Getting started +--------------- + +First you'll need to get the source of the project. Do this by cloning the +whole Graphene repository: + +```bash +# Get the example project code +git clone https://github.com/graphql-python/graphene.git +cd graphene/examples/cookbook +``` + +It is good idea (but not required) to create a virtual environment +for this project. We'll do this using +[virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) +to keep things simple, +but you may also find something like +[virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/) +to be useful: + +```bash +# Create a virtualenv in which we can install the dependencies +virtualenv env +source env/bin/activate +``` + +Now we can install our dependencies: + +```bash +pip install -r requirements.txt +``` + +Now setup our database: + +```bash +# Setup the database +./manage.py migrate + +# Load some example data +./manage.py loaddata ingredients + +# Create an admin user (useful for logging into the admin UI +# at http://127.0.0.1:8000/admin) +./manage.py createsuperuser +``` + +Now you should be ready to start the server: + +```bash +./manage.py runserver +``` + +Now head on over to +[http://127.0.0.1:8000/graphiql](http://127.0.0.1:8000/graphiql) +and run some queries! +(See the [Django quickstart guide](http://graphene-python.org/docs/quickstart-django/) +for some example queries) diff --git a/examples/cookbook/requirements.txt b/examples/cookbook/requirements.txt index 2c9fa4d2..0fd3c2da 100644 --- a/examples/cookbook/requirements.txt +++ b/examples/cookbook/requirements.txt @@ -1,5 +1,5 @@ --e git+https://github.com/adamcharnock/graphene.git@feature/django#egg=graphene -graphql-core==0.4.12 +graphene[django] +django_graphiql +graphql-core django==1.9 -django_graphiql==0.4.2 django-filter==0.11.0