Introduction

A framework for building GraphQL APIs without defining any kind of schema. It reduces the time spent on writing and maintaining API definitions, allowing you to focus solely on writing your service logic.

Why

We believe that the current approach to building APIs is outdated. Writing and maintaining API definitions is time-consuming and error-prone. When you already have TypeScript definitions, why not use them to infer the API schema? Pylon does exactly that.

Pylon also provides a set of tools to help you build, test, and deploy your APIs. We believe that building services should be easy and fun. Major functionalities like authentication, authorization, and context management are built-in, so you can focus on what matters most: your service logic.

With Pylon, you can build APIs faster, with fewer errors, and with less code.

Create

To create a new Pylon project, run the following command:

npm create pylon@latest

Afterwards, you can navigate to the newly created project and start the development server:

cd my-pylon
npm run dev

This will start the development server on http://localhost:3000.

Open the Pylon Playground in your browser and start building your API.

Develop

Update your service logic in the src directory.

import {app} from '@getcronit/pylon'

export const graphql = {
  Query: {
    user: (id: string) => {
      return {
        id,
        name: 'John Doe',
        email: 'johndoe@example.com'
      }
    },
    products: () => [
      {id: '1', name: 'Laptop', price: 999.99},
      {id: '2', name: 'Smartphone', price: 499.99},
      {id: '3', name: 'Tablet', price: 299.99}
    ]
  },
  Mutation: {
    updateUserEmail: (id: string, newEmail: string) => {
      return {
        id,
        email: newEmail
      }
    },
    createOrder: (userId: string, productIds: string[]) => {
      return {
        id: 'order-123',
        userId,
        productIds,
        status: 'PENDING'
      }
    }
  }
}

export default app

Query:

query GetUser {
  user(id: "1") {
    id
    name
    email
  }
}

query GetProducts {
  products {
    id
    name
    price
  }
}

Mutation:

mutation UpdateUserEmail {
  updateUserEmail(id: "1", newEmail: "johndoe2@example.com") {
    id
    email
  }
}

mutation CreateOrder {
  createOrder(userId: "1", productIds: ["1", "2"]) {
    id
    userId
    productIds
    status
  }
}

Deploy

Pylon is fully compatible with Cloudflare Workers, allowing you to deploy your service to the edge in just one minute. Watch the video below to see how easy it is to deploy a Pylon.

If you prefer to deploy your service to a different platform, you can use the provided Dockerfile to build a Docker image and deploy it to your favorite cloud provider.

docker build -t my-pylon .
docker run -p 3000:3000 my-pylon

Runtimes

Designed to be flexible, Pylon can be run on various platforms, including:

Bun.js	Node.js	Cloudflare Workers	Deno

Features

Pylon offers a comprehensive set of features to streamline the development of modern web services:

Playground

You can try Pylon in the Playground without installing anything. Or simply click the image below to open the Playground.

Contributing

Documentation, bug reports, pull requests, and other contributions are welcomed! See CONTRIBUTING.md for more information.

Support

• Community Support: Join the Pylon community on GitHub to report bugs and request features.
• Professional Support: For professional support and consulting services, contact office@cronit.io.
• Join the Pylon Discord server to connect with other users and contributors.

Pylon is brought to you by Cronit.