Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
schettn authored Sep 12, 2024
1 parent 1aa9c42 commit be42eb4
Showing 1 changed file with 78 additions and 20 deletions.
98 changes: 78 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,98 @@
:rocket: **Pylon now supports Node.JS, Bun a and Cloudflare Workers!**. Check out the [Pylon v2.0.0 release notes](https://pylon.cronit.io/docs/release-notes/v2.0) for more information.
![Pylon cover](https://github.com/user-attachments/assets/c28e49b2-5672-4849-826e-8b2eab0360cc)

<p align="center">
<a href="https://pylon.cronit.io">
<img src="https://github.com/getcronit/pylon/assets/52858351/ec8aa54e-6b24-45cb-82a1-03b9c8b8f45f" height="100" alt="gqty" />
</a>
</p>
<div align="center"><strong>Pylon</strong></div>
<div align="center">The next generation of building APIs.<br />Automatic schema generation for your service logic.</div>
<br />
<div align="center">
<a href="https://pylon.cronit.io">Website</a>
<span> · </span>
<a href="https://github.com/getcronit/pylon">GitHub</a>
<span> · </span>
<a href="https://discord.com/invite/cbJjkVrnHe">Discord</a>

<h2 align="center">
From Functions to APIs - Instantly
<br />
<br />

[![Documentation](https://img.shields.io/badge/documentation-documentation?color=C00B84)](https://pylon.cronit.io)
[![Documentation](https://img.shields.io/badge/documentation-documentation?color=000000)](https://pylon.cronit.io/docs)
[![NPM](https://img.shields.io/npm/v/%40getcronit%2Fpylon)](https://www.npmjs.com/package/@getcronit/pylon)

</h2>
</div>

[![Pylon Hero Section](https://github.com/user-attachments/assets/c715b5f8-58ac-4967-801a-77a8cd843813)](https://pylon.cronit.io)
## Introduction

The GraphQL schema is generated in real-time from your TypeScript definitions,
allowing you to focus solely on writing your service logic.
This approach significantly improves development speed, enhances type safety, and reduces errors.
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.

Any breaking changes in your code are instantly reflected in your API,
enabling you to immediately see how changes impact its functionality.
## Why

**Head over to [pylon.cronit.io](https://pylon.cronit.io) to explore features and
documentations!**
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.

## Get involved
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 Your First Pylon

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

```bash
npm create pylon
```

It will guide you through the process of creating a new Pylon project.

Supported runtimes:

- Bun.js (https://bunjs.dev)
- Node.js (https://nodejs.org)
- Cloudflare Workers (https://workers.cloudflare.com)

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

```bash
cd my-pylon-project
npm run dev
```

This will start the development server on `http://localhost:3000`. Now you can open the [Pylon Playground](https://pylon.cronit.io/docs/getting-started#built-in-graphql-playground) in your browser and start building your API.

![Pylon Create and Fetch](https://github.com/user-attachments/assets/c715b5f8-58ac-4967-801a-77a8cd843813)

## Go from Zero to Production in Just One Minute with Cloudflare Workers

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.

[![Cloudflare Workers](https://video.com)]

## Features

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

- **Automatic GraphQL API Generation**: Pylon generates GraphQL schemas based on your TypeScript definitions, ensuring type safety and reducing manual coding effort.
- **Type Safety**: By leveraging TypeScript, Pylon ensures that your services are type-safe, catching errors at compile time.
- **Authentication and Authorization**: Built-in support for OIDC standard and integration with ZITADEL for managing user authentication and role-based access control.
- **Logging and Monitoring**: Sentry for error tracking, providing robust monitoring capabilities.
- **Database Integration**: Seamlessly works with Prisma to generate extended models that support automatic resolution of relations and paginatable connections.
- **Deployment Ready**: Includes pre-configured Dockerfile for easy deployment using Docker or manual methods.

## Test Drive Pylon

You can try Pylon in the [Playground](https://pylon.cronit.io/playground) without installing anything.
Or simply click the image below to open the Playground.

[![Playground](https://github.com/user-attachments/assets/39df08d0-4094-4836-a36b-37ad62e292cf)](https://pylon.cronit.io/playground)

## Get Involved

Documentation, bug reports, pull requests, and other contributions are welcomed!
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information.

## Getting help
## Getting Help

- **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](mailto:office@cronit.io).
- Join the [Pylon Discord server](https://discord.gg/cbJjkVrnHe) to connect with other users and contributors.

---

Expand Down

0 comments on commit be42eb4

Please sign in to comment.