mirror of
https://github.com/graphql-python/graphene.git
synced 2025-02-08 23:50:38 +03:00
Adding Readme file to cookbook example project
This commit is contained in:
parent
716aa8ff66
commit
442998cbb3
64
examples/cookbook/README.md
Normal file
64
examples/cookbook/README.md
Normal file
|
@ -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)
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue
Block a user