https://github.com/willianantunes/django-graphql-playground

Yet another Django GraphQL Playground project
https://github.com/willianantunes/django-graphql-playground

django django-rest-framework graphene graphene-django graphql pytest-django python

Last synced: 3 months ago
JSON representation

Yet another Django GraphQL Playground project

• Host: GitHub
• URL: https://github.com/willianantunes/django-graphql-playground
• Owner: willianantunes
• Created: 2019-03-06T21:45:54.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-12-12T17:08:15.000Z (about 4 years ago)
• Last Synced: 2023-08-07T23:34:41.463Z (over 1 year ago)
• Topics: django, django-rest-framework, graphene, graphene-django, graphql, pytest-django, python
• Language: Python
• Homepage:
• Size: 199 KB
• Stars: 12
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Django GraphQL Playground

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=coverage)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=ncloc)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=security_rating)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=sqale_index)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=willianantunes_django-graphql-playground&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=willianantunes_django-graphql-playground)

An honest place to play with this fantastic framework with GraphQL with help of [Graphene](https://github.com/graphql-python/graphene).

## Run NOW with Docker

Simply execute:

    docker run -itd --name django-graphql-playground \

    -p 8000:80 \

    willianantunes/django-graphql-playground \

    /bin/bash /app/start.sh

Access on your browser: http://localhost:8000/admin/

See the logs:

    docker logs -f django-graphql-playground

## Preparing your dev environment

This project uses `pipenv`, so you must have it (see how [here](https://pipenv.readthedocs.io/en/latest/#install-pipenv-today)). [It is the recommended tool to work with dependency management by python.org](https://packaging.python.org/guides/tool-recommendations/).

At the root of project, issue the following command:

    pipenv install --dev --ignore-pipfile

Then do the following commands:

    pipenv run python manage.py makemigrations

    pipenv run python manage.py migrate

Run it:

    pipenv run python manage.py runserver

    

Or if you prefer:

    docker-compose up

## Tests

I did some integration tests to see if [Grafene Testing Tools](https://docs.graphene-python.org/en/latest/testing/#testing-tools) is who he really says he is.

Execute the following to test everything:

    PIPENV_DONT_LOAD_ENV=1 pipenv run pytest --ignore-glob='**/pubsub/**/*.py' 

Useful links:

- https://docs.graphene-python.org/en/latest/testing/#testing-tools

- https://pytest-django.readthedocs.io/en/latest/helpers.html

- https://gist.github.com/JamesMGreene/cdd0ac49f90c987e45ac

## Issues

- [Pipeline for Django fails with: No module named '_sqlite3'](https://developercommunity.visualstudio.com/content/problem/574733/pipeline-for-django-fails-with-no-module-named-sql.html)

- [GitHubInstallationTokenSignatureSecret](https://developercommunity.visualstudio.com/content/problem/564582/githubinstallationtokensignaturesecret-does-not-ex.html)

- [Azure DevOps Output Variable](https://github.com/microsoft/azure-pipelines-agent/blob/master/docs/preview/outputvariable.md)