diff --git a/README.md b/README.md deleted file mode 100644 index 0c84cb0..0000000 --- a/README.md +++ /dev/null @@ -1,215 +0,0 @@ -

- - SNEK Logo - -

- - -
Psylon
-
The next generation of building APIs.
Automatic schema generation for your service logic.
-
-
-Website - · -GitHub - · -Discord - -
-
- -[![Documentation](https://img.shields.io/badge/documentation-documentation?color=000000)](https://pylon.cronit.io/docs) -[![NPM](https://img.shields.io/npm/v/psylon)](https://www.npmjs.com/package/psylon) -[![Discord](https://img.shields.io/discord/1270327745662029854)](https://discord.com/invite/cbJjkVrnHe) - -
- -## 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? Psylon does exactly that. - -Psylon 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 Psylon, you can build APIs faster, with fewer errors, and with less code. - -## About - -Psylon is a Pylon v2 fork maintained by Netsnek e. U., tuned to behave like its -predecessor snek-functions and laser-focused on seamless microservice interoperability. - -Unlike Pylon v3, which aims to become a full-stack framework, Psylon is and will -remain a GraphQL-based microservice framework. Security fixes and compatible -behavioural changes from Pylon v3 that improve the v2 runtime will be backported -to Psylon where appropriate. - -Canonical repository: https://github.com/netsnek/psylon - -## Roadmap - -Psylons roadmap is centered around GraphQL via GQty and its pgqty fork. -For current plans and discussion, see -[gqty-dev/gqty#2051](https://github.com/gqty-dev/gqty/issues/2051). - -## Create - -To create a new Psylon project, run the following command: - -```bash -npm create psylon@latest -``` - -Afterwards, you can navigate to the newly created project and start the development server: - -```bash -cd my-psylon -npm run dev -``` - -This will start the development server on `http://localhost:3000`. - -Open the [Psylon Playground](https://pylon.cronit.io/docs/getting-started#built-in-graphql-playground) in your browser and start building your API. - -## Develop - -Update your service logic in the `src` directory. - -```typescript -import {app} from 'psylon' - -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:** - -```graphql -query GetUser { - user(id: "1") { - id - name - email - } -} - -query GetProducts { - products { - id - name - price - } -} -``` - -**Mutation:** - -```graphql -mutation UpdateUserEmail { - updateUserEmail(id: "1", newEmail: "johndoe2@example.com") { - id - email - } -} - -mutation CreateOrder { - createOrder(userId: "1", productIds: ["1", "2"]) { - id - userId - productIds - status - } -} -``` - -## Deploy - -Psylon 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 Psylon. - -![Cloudflare Workers](https://github.com/user-attachments/assets/8e9f96a7-47e3-4c66-8426-fe09329de598) - -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. - -```bash -docker build -t my-pylon . -docker run -p 3000:3000 my-pylon -``` - -## Runtimes - -Designed to be flexible, Psylon can be run on various platforms, including: - -| Bun.js logo | Node.JS | Gmail logo | Deno logo | -| :------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------- | -| Bun.js | Node.js | Cloudflare Workers | Deno | - -## Features - -Psylon offers a comprehensive set of features to streamline the development of modern web services: - -| Feature | Description | -| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| **Automatic Schema Generation** | Psylon generates GraphQL schemas based on your TypeScript definitions, ensuring type safety and reducing manual coding effort. | -| **Type Safety** | By leveraging TypeScript, Psylon 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. | - -## Playground - -You can try Psylon 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) - -## Contributing - -Documentation, bug reports, pull requests, and other contributions are welcomed! -See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information. - -## Support - -- **Community Support:** Join the Psylon 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 [Psylon Discord server](https://discord.gg/cbJjkVrnHe) to connect with other users and contributors. - ---- - -Psylon is brought to you by Cronit. diff --git a/README.md b/README.md new file mode 120000 index 0000000..543804d --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +packages/pylon/README.md \ No newline at end of file diff --git a/packages/pylon/README.md b/packages/pylon/README.md index 93f62ea..0c84cb0 100644 --- a/packages/pylon/README.md +++ b/packages/pylon/README.md @@ -4,13 +4,12 @@

-![Psylon cover](https://github.com/user-attachments/assets/c28e49b2-5672-4849-826e-8b2eab0360cc)
Psylon
The next generation of building APIs.
Automatic schema generation for your service logic.

-Website +Website · GitHub · @@ -32,31 +31,33 @@ It reduces the time spent on writing and maintaining API definitions, allowing y ## 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. +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? Psylon 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. +Psylon 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. +With Psylon, you can build APIs faster, with fewer errors, and with less code. -## Roadmap +## About + +Psylon is a Pylon v2 fork maintained by Netsnek e. U., tuned to behave like its +predecessor snek-functions and laser-focused on seamless microservice interoperability. + +Unlike Pylon v3, which aims to become a full-stack framework, Psylon is and will +remain a GraphQL-based microservice framework. Security fixes and compatible +behavioural changes from Pylon v3 that improve the v2 runtime will be backported +to Psylon where appropriate. -We would love to hear your feedback and suggestions for new features. Please open an issue or join our Discord server to share your thoughts. +Canonical repository: https://github.com/netsnek/psylon + +## Roadmap -- [ ] **Documentation:** Improve the documentation and provide more examples. -- [ ] **Testing:** Add a test suite to ensure the stability of the framework. [#7](https://github.com/getcronit/pylon/issues/7) -- [ ] **Breaking Change Detection:** Implement a mechanism to detect breaking changes in the generated schema. [#8](https://github.com/getcronit/pylon/issues/8) -- [ ] **Date-Based Versioning:** Automatically version the service when backward-incompatible changes are made. This will ensure that clients are aware of the changes and can adapt accordingly. This should be similar to the way Shopify handles API versioning. [#9](https://github.com/getcronit/pylon/issues/9) -- [ ] **GraphQL Directives:** Allow users to define custom directives that can be used to modify the generated schema. These directives should then be applied to the service logic (schema) to provide additional functionality. More information can be found in the [GraphQL spec](https://spec.graphql.org/June2018/#sec-Type-System.Directives). -- [ ] **Support Custom Authentication:** Currently, Pylon only supports OIDC for ZITADEL for authentication. We would like to add support for different authentication methods, such as JWT, OAuth, and others. This will then be used by the ´requireAuth´ function to authenticate / authorize users. [#21](https://github.com/getcronit/pylon/issues/21) -- [ ] **Better Prisma Integration:** Improve the integration with Prisma to provide a more seamless experience when working with databases. This includes better support for relations, pagination, and other features provided by Prisma. The main pain point is that prisma does not include relations by default, so a lot of manual work is required to add them. To solve this, we would like to leverage the prisma client extensions to automatically resolve relations and provide paginatable connections. -- [ ] **Find Edge Cases:** Find edge cases where the generated schema does not match the service logic, or build errors occur. This will help to improve the overall stability of the framework and provide a better developer experience. -- [ ] **Fix the Sentry Integration:** Currently, the Sentry integration is not working as expected. We would like to fix this and provide better error tracking capabilities for Pylon users. -- [ ] **Integrate @netsnek/psylon-builder into @netsnek/psylon-dev:** The pylon-builder package is used to generate the schema from the service logic. Currently, this is a separate package that gets installed alongside the pylon-dev package. This means that there could be version mismatches between the two packages. To solve this, we would like to integrate the builder into the dev package so that they are always in sync. This will also make it easier to maintain and update the packages. -- [ ] **Spread the Word:** Spread the word about Pylon and get more people involved in the project. This includes writing blog posts, creating videos, and sharing the project on social media. +Psylons roadmap is centered around GraphQL via GQty and its pgqty fork. +For current plans and discussion, see +[gqty-dev/gqty#2051](https://github.com/gqty-dev/gqty/issues/2051). ## Create -To create a new Pylon project, run the following command: +To create a new Psylon project, run the following command: ```bash npm create psylon@latest @@ -65,13 +66,13 @@ npm create psylon@latest Afterwards, you can navigate to the newly created project and start the development server: ```bash -cd my-pylon +cd my-psylon npm run dev ``` This will start the development server on `http://localhost:3000`. -Open the [Pylon Playground](https://pylon.cronit.io/docs/getting-started#built-in-graphql-playground) in your browser and start building your API. +Open the [Psylon Playground](https://pylon.cronit.io/docs/getting-started#built-in-graphql-playground) in your browser and start building your API. ## Develop @@ -158,8 +159,8 @@ mutation CreateOrder { ## 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. +Psylon 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 Psylon. ![Cloudflare Workers](https://github.com/user-attachments/assets/8e9f96a7-47e3-4c66-8426-fe09329de598) @@ -172,7 +173,7 @@ docker run -p 3000:3000 my-pylon ## Runtimes -Designed to be flexible, Pylon can be run on various platforms, including: +Designed to be flexible, Psylon can be run on various platforms, including: | Bun.js logo | Node.JS | Gmail logo | Deno logo | | :------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------- | @@ -180,12 +181,12 @@ Designed to be flexible, Pylon can be run on various platforms, including: ## Features -Pylon offers a comprehensive set of features to streamline the development of modern web services: +Psylon offers a comprehensive set of features to streamline the development of modern web services: | Feature | Description | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| **Automatic Schema 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. | +| **Automatic Schema Generation** | Psylon generates GraphQL schemas based on your TypeScript definitions, ensuring type safety and reducing manual coding effort. | +| **Type Safety** | By leveraging TypeScript, Psylon 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. | @@ -193,7 +194,7 @@ Pylon offers a comprehensive set of features to streamline the development of mo ## Playground -You can try Pylon in the [Playground](https://pylon.cronit.io/playground) without installing anything. +You can try Psylon 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) @@ -205,10 +206,10 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information. ## Support -- **Community Support:** Join the Pylon community on GitHub to report bugs and request features. +- **Community Support:** Join the Psylon 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. +- Join the [Psylon Discord server](https://discord.gg/cbJjkVrnHe) to connect with other users and contributors. --- -Pylon is brought to you by Cronit. +Psylon is brought to you by Cronit.