From 37c3962204136edafebba8bafd779ea903e32700 Mon Sep 17 00:00:00 2001 From: "Marc J. Schmidt" Date: Fri, 2 Dec 2022 13:32:40 +0100 Subject: [PATCH] chore: add links to community packages and examples to readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index a97a200d0..469475a2f 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,26 @@ The team is working hard towards a stable beta release. Check out the [Deepkit Documentation](https://deepkit.io/documentation) to get started. +## Getting started + +```shell +npm init @deepkit/app my-deepkit-app +``` + +## Community Packages + +- [Deepkit OpenAPI](https://github.com/hanayashiki/deepkit-openapi): Automatic OpenAPI doc and Swagger UI generation based on HTTP routes. +- [Serverless Adapter](https://github.com/H4ad/serverless-adapter): Run Deepkit on top of AWS Lambda, Azure, Digital Ocean and many other clouds. +- [Deepkit REST](https://github.com/deepkit-rest/rest): DeepKit REST opens up a whole new declarative and extensive approach for developing REST APIs. +- [Deepkit Stripe](https://github.com/deepkit-community/modules/tree/master/packages/stripe): Interacting with the Stripe API or consuming Stripe webhooks in your Deepkit applications is now easy as pie 🥧. + +## Examples + +- [Deepkit example with HTTP, RPC, and CLI controller](https://github.com/deepkit/deepkit-framework/blob/master/packages/example-app/app.ts). +- [Deepkit HTTP router with custom http server](https://github.com/deepkit/deepkit-framework/blob/master/packages/example-app/slim.ts). +- [Deepkit Bookstore](https://github.com/marcj/deepkit-bookstore): Auto REST CRUD + Deepkit API Console. +- [Deepkit Webpack](https://github.com/marcj/deepkit-webpack): Type Compiler with Webpack. + ## Contributing If you are interested in contributing to the development of Deepkit, check out the [Development Docs](./DEVELOPMENT.md) to learn more about setting up your local development environment.