graphene/graphene-sqlalchemy/examples/flask_sqlalchemy/README.md

51 lines
1.2 KiB
Markdown
Raw Normal View History

Example Flask+SQLAlchemy Project
================================
2016-01-23 08:44:41 +03:00
This example project demos integration between Graphene, Flask and SQLAlchemy.
The project contains two models, one named `Department` and another
named `Employee`.
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
2016-01-23 22:00:00 +03:00
cd graphene/examples/flask_sqlalchemy
2016-01-23 08:44:41 +03:00
```
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 the following command will setup the database, and start the server:
```bash
./app.py
```
Now head on over to
2016-01-23 22:00:00 +03:00
[http://127.0.0.1:5000/graphiql](http://127.0.0.1:5000/graphiql)
2016-01-23 08:44:41 +03:00
and run some queries!