Graphene Python with FastAPI Template for Vercel Deployment of GraphQL API

This repository serves as a cookiecutter template for utilizing the Graphene Python package along with FastAPI and deploying the application to Vercel.

Overview

This project provides a structured starting point for building GraphQL APIs using Graphene and FastAPI, and deploying the application to Vercel. It's designed to streamline the setup process and enable developers to quickly begin developing GraphQL APIs using these technologies.

Features

Graphene: Utilizes Graphene, a Python library for building GraphQL APIs.
FastAPI: Integrates FastAPI, a modern web framework for building APIs with Python 3.7+.
Vercel Deployment: Offers configuration files and guidelines to deploy the application to Vercel's platform.

Requirements

Make sure you have the following installed before using this template:

Python 3.7+
Cookiecutter
Pip (Python Package Installer) or make a virtural environment with Pipenv
Vercel CLI (for deployment): A Vercel JSON file is ready to go in this cookiecutter

Install with Cookiecutter

cookiecutter https://github.com/mrcartoonster/graphene_cookiecutter.git

Structure

The project structure is organized as follows:

{{cookiecutter.project}}
├── app
│   ├── db
│   │   ├── database.py
│   │   ├── data.py
│   │   ├── __init__.py
│   │   └── models.py
│   ├── gql
│   │   ├── __init__.py
│   │   ├── mutations.py
│   │   ├── queries.py
│   │   └── types.py
│   ├── __init__.py
│   └── utils.py
├── main.py
├── requirements.txt
└── vercel.json

Contributing

Contributions are welcome! Please fork the repository and create a pull request for any enhancements or fixes.

License

This project is licensed under the MIT License.

Acknowledgments

Special thanks to the maintainers of CookieCutter, Graphene, FastAPI, and Vercel for their fantastic tools and documentation.

mrcartoonster / graphene_cookiecutter