{"id":19854646,"url":"https://github.com/obytes/fastql","last_synced_at":"2025-05-02T01:30:34.662Z","repository":{"id":38350460,"uuid":"413878651","full_name":"obytes/FastQL","owner":"obytes","description":"⚙️  Full stack, Modern Web Application Generator. ✨ Using FastAPI, GraphQL, PostgreSQL as database, Docker, automatic HTTPS and more. 🔖","archived":false,"fork":false,"pushed_at":"2023-03-13T16:00:31.000Z","size":305,"stargazers_count":136,"open_issues_count":8,"forks_count":21,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-06T20:25:58.207Z","etag":null,"topics":["ariadne","docker","fastapi","graphene","graphql","postgresql","python","rabbitmq"],"latest_commit_sha":null,"homepage":"https://www.obytes.com/blog/getting-started-with-graphql-in-python-with-fastapi-\u0026-ariadne","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/obytes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-10-05T15:38:44.000Z","updated_at":"2025-03-09T15:55:09.000Z","dependencies_parsed_at":"2023-02-19T09:16:04.814Z","dependency_job_id":"5b10377e-3ba8-46b8-90cf-bbecaf58e4a5","html_url":"https://github.com/obytes/FastQL","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obytes%2FFastQL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obytes%2FFastQL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obytes%2FFastQL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/obytes%2FFastQL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/obytes","download_url":"https://codeload.github.com/obytes/FastQL/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251969245,"owners_count":21673182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ariadne","docker","fastapi","graphene","graphql","postgresql","python","rabbitmq"],"created_at":"2024-11-12T14:10:02.710Z","updated_at":"2025-05-02T01:30:34.134Z","avatar_url":"https://github.com/obytes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FastQL - FastAPI GraphQL Playground 🔧\n\n![fastql](.github/header.svg)\n\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eGenerate a FullStack playground using FastAPI and GraphQL and Ariadne ⚡\u003c/em\u003e\n\u003c/p\u003e\n\nThis Repository is based on this Article [Getting started with GraphQL in Python with FastAPI and Ariadne](https://www.obytes.com/blog/getting-started-with-graphql-in-python-with-fastapi-and-ariadne), Read Article to know how to use it.\n\n## Overview 📌\n\n- FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.\n- GraphQL used to create a schema to describe all the possible data that clients can query through that service. A GraphQL schema is made up of object types, which define which kind of object you can request and what fields it has.\n- Ariadne is a Python library for implementing GraphQL servers using schema-first approach.\n\n## Features\n\n- Full Docker integration (Docker based).\n- Docker Compose integration and optimization for local development.\n- Production ready Python web server using Uvicorn and Gunicorn.\n- **GraphQL** playground based on Graphene and Ariadne.\n- **Docker Compose** integration and optimization for local development.\n- **Production ready** Python web server using Uvicorn.\n- **Secure password** hashing by default.\n- **JWT token** authentication.\n- **SQLAlchemy** database integration using PostgreSQL.\n- **Alembic** migrations for database schema.\n- **rabbitMQ** (asynchronous) message broker.\n- API tests based on **Pytest**, integrated with Docker, so you can test the full API interaction, independent on the database.\n\n## Getting Started\n\n### Project setup\n\n```sh\n# clone the repo\n$ git clone https://github.com/obytes/fastql.git\n\n# move to the project folder\n$ cd fastql\n```\n\n## Running the Docker Container\n\n- We have the Dockerfile created in above section. Now, we will use the Dockerfile to create the image of the FastAPI app and then start the FastAPI app container.\n- Using a preconfigured `Makefile` tor run the Docker Compose:\n\n```sh\n# Pull the latest image\n$ make pull\n\n# Build the image\n$ make build\n\n# Run the container\n$ make start\n```\n\n### Testing\n\nWhile i use `HTTPX` an HTTP client for Python 3, to test the API, most of the tests are using a live log thats why need before to run a server using `uvicorn` and migrate the database, then you will have the ability to run the tests. To have a clean environment, recommended to use Docker for that, when you start the containers try to open the application container and then run `pytest` to test the API.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobytes%2Ffastql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobytes%2Ffastql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobytes%2Ffastql/lists"}