FireCorn

Author: Mitchell Murphy
Date: 11 June 2021
Version: 0.1.0

Introduction

This project is a very simple blog GraphQL API that uses FastAPI, Starlette, Orator, Graphene and Uvicorn. A Dockerfile is provided, in order to use this app you either need to override the database environment variables to use SQLite or create a PostgreSQL database (and user), and then run the migrations as so: cd src && orator migrate -c db.py.

Dependency Management

This app uses the Poetry Python packaging and dependency management system. If you would like to run this application locally (it is recommended that you use the included Dockerfile), you need to create a virtual environment and install the dependencies as so:

poetry shell
poetry install

Run

This application can be run locally or via Docker (suggested). To run locally (after entering the virtual environment as instructed above), issue the following command: uvicorn --factory src.app:create_app --reload --port 8080

Docker

docker build -t superfast/blog:0.1.0 .
docker run --rm -it -p 8080:8080 superfast/blog:0.1.0

Docker-compose

I have included a docker-compose.yml file that will start a PostgreSQL 12 instance, all you need to do is run docker-compose up --build -d and access the API at http://localhost:8080

Tests

Run tests with: python -m pytest -s tests. Currently there are 9 tests: 3 for User, Post and Comments, and coverage is at 100%.

Example Mutations/Queries

mutation createUser {
  createUser(userDetails: {
    name: "John Doe",
    address: "Some address",
    phoneNumber: "12345678",
    sex: "male"
  })
  {
    id
    name
    posts {
      body
      comments {
        body
      }
    }
  }
}

mutation createPost {
  createPost(postDetails: {
    userId: 1,
    title: "My first Post",
    body: "This is a Post about myself"
  })
  {
    id
  }
}

mutation createComment {
  createComment(commentDetails: {
    userId: 1,
    postId: 1,
    body: "Another Comment"
  })
  {
    id
    body
  }
}

query getUser {
  getUser(userId: 1) {
    name
    posts {
      title
      comments {
        body
      }
    }
    comments {
      body
    }
  }
}

mkm29/firecorn