From 477b1cc0607e4a0da26302ad9e6f26521edddc9d Mon Sep 17 00:00:00 2001 From: beerose Date: Tue, 6 Feb 2024 21:24:29 +0100 Subject: [PATCH 1/3] Add README.md files for @edgedb/create recipes --- packages/create/src/recipes/express/README.md | 51 +++++++++++++++++++ packages/create/src/recipes/nextjs/README.md | 51 +++++++++++++++++++ packages/create/src/recipes/remix/README.md | 51 +++++++++++++++++++ 3 files changed, 153 insertions(+) create mode 100644 packages/create/src/recipes/express/README.md create mode 100644 packages/create/src/recipes/nextjs/README.md create mode 100644 packages/create/src/recipes/remix/README.md diff --git a/packages/create/src/recipes/express/README.md b/packages/create/src/recipes/express/README.md new file mode 100644 index 000000000..290d0fb72 --- /dev/null +++ b/packages/create/src/recipes/express/README.md @@ -0,0 +1,51 @@ +# Express Integration Recipe for EdgeDB + +This recipe provides a starting point for building an [Express](https://expressjs.com/) application with EdgeDB as the database. + +We try to actively monitor and incorporate significant changes from the original "create-app" templates to to ensure developers have access to the latest features and best practices. + +✨ Check out the [`@edgedb/create` package](https://github.com/edgedb/edgedb-js/blob/master/packages/create/README.md) for more information. + +## Usage + +```bash +$ npm create @edgedb +# or +yarn create @edgedb +# or +pnpm create @edgedb +# or +bun create @edgedb +``` + +After running the command, you will be prompted to provide a project name and choose the **"Express"** template. You can also specify whether to use EdgeDB Auth, initialize a git repository, and install dependencies. + +The tool will then create a new directory with the specified name and set up the project. + +### Local Recipe Development + +Install dependencies in the root directory: + +```bash +$ yarn +``` + +Navigate into `packages/create`: + +```bash +$ cd packages/create +``` + +Build @edgedb/create + +```bash +$ yarn build +``` + +Run a local version: + +```bash +$ yarn create +``` + +Then choose the **"Express"** template. diff --git a/packages/create/src/recipes/nextjs/README.md b/packages/create/src/recipes/nextjs/README.md new file mode 100644 index 000000000..9f39cae12 --- /dev/null +++ b/packages/create/src/recipes/nextjs/README.md @@ -0,0 +1,51 @@ +# NextJS Integration Recipe for EdgeDB + +This recipe provides a starting point for building a [Next.js](https://nextjs.org/) application with EdgeDB as the database. It is based on the official Next.js starter template. + +We try to actively monitor and incorporate significant changes from the original "create-app" templates to to ensure developers have access to the latest features and best practices. However, we might not cover every possible configuration or permutation due to the vast scope of possibilities. + +✨ Check out the [`@edgedb/create` package](https://github.com/edgedb/edgedb-js/blob/master/packages/create/README.md) for more information. + +## Usage + +```bash +$ npm create @edgedb +# or +yarn create @edgedb +# or +pnpm create @edgedb +# or +bun create @edgedb +``` + +After running the command, you will be prompted to provide a project name and choose the **"NextJS"** template. You can also specify whether to use EdgeDB Auth, initialize a git repository, and install dependencies. + +The tool will then create a new directory with the specified name and set up the project. + +### Local Recipe Development + +Install dependencies in the root directory: + +```bash +$ yarn +``` + +Navigate into `packages/create`: + +```bash +$ cd packages/create +``` + +Build @edgedb/create + +```bash +$ yarn build +``` + +Run a local version: + +```bash +$ yarn create +``` + +Then choose the **"NextJS"** template. diff --git a/packages/create/src/recipes/remix/README.md b/packages/create/src/recipes/remix/README.md new file mode 100644 index 000000000..e1855ab75 --- /dev/null +++ b/packages/create/src/recipes/remix/README.md @@ -0,0 +1,51 @@ +# Remix Integration Recipe for EdgeDB + +This recipe provides a starting point for building a [Remix](https://remix.run/) application with EdgeDB as the database. It is based on the official Remix starter template. + +We try to actively monitor and incorporate significant changes from the original "create-app" templates to to ensure developers have access to the latest features and best practices. However, we might not cover every possible configuration or permutation due to the vast scope of possibilities. + +✨ Check out the [`@edgedb/create` package](https://github.com/edgedb/edgedb-js/blob/master/packages/create/README.md) for more information. + +## Usage + +```bash +$ npm create @edgedb +# or +yarn create @edgedb +# or +pnpm create @edgedb +# or +bun create @edgedb +``` + +After running the command, you will be prompted to provide a project name and choose the **"Remix"** template. You can also specify whether to use EdgeDB Auth, initialize a git repository, and install dependencies. + +The tool will then create a new directory with the specified name and set up the project. + +### Local Recipe Development + +Install dependencies in the root directory: + +```bash +$ yarn +``` + +Navigate into `packages/create`: + +```bash +$ cd packages/create +``` + +Build @edgedb/create + +```bash +$ yarn build +``` + +Run a local version: + +```bash +$ yarn create +``` + +Then choose the **"Remix"** template. From 27950dc76fecc42a696069ffb80ab60871a4c78f Mon Sep 17 00:00:00 2001 From: beerose Date: Tue, 6 Feb 2024 21:25:39 +0100 Subject: [PATCH 2/3] Update title --- packages/create/src/recipes/express/README.md | 2 +- packages/create/src/recipes/nextjs/README.md | 2 +- packages/create/src/recipes/remix/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/create/src/recipes/express/README.md b/packages/create/src/recipes/express/README.md index 290d0fb72..c26b8205f 100644 --- a/packages/create/src/recipes/express/README.md +++ b/packages/create/src/recipes/express/README.md @@ -22,7 +22,7 @@ After running the command, you will be prompted to provide a project name and ch The tool will then create a new directory with the specified name and set up the project. -### Local Recipe Development +## Local Recipe Development Install dependencies in the root directory: diff --git a/packages/create/src/recipes/nextjs/README.md b/packages/create/src/recipes/nextjs/README.md index 9f39cae12..168ae6459 100644 --- a/packages/create/src/recipes/nextjs/README.md +++ b/packages/create/src/recipes/nextjs/README.md @@ -22,7 +22,7 @@ After running the command, you will be prompted to provide a project name and ch The tool will then create a new directory with the specified name and set up the project. -### Local Recipe Development +## Local Recipe Development Install dependencies in the root directory: diff --git a/packages/create/src/recipes/remix/README.md b/packages/create/src/recipes/remix/README.md index e1855ab75..84a94fa57 100644 --- a/packages/create/src/recipes/remix/README.md +++ b/packages/create/src/recipes/remix/README.md @@ -22,7 +22,7 @@ After running the command, you will be prompted to provide a project name and ch The tool will then create a new directory with the specified name and set up the project. -### Local Recipe Development +## Local Recipe Development Install dependencies in the root directory: From fe5e97ffe67d9ad29d92628f9060a8d0ef996b68 Mon Sep 17 00:00:00 2001 From: beerose Date: Wed, 7 Feb 2024 11:52:46 +0100 Subject: [PATCH 3/3] apply review comments --- packages/create/src/recipes/express/README.md | 2 -- packages/create/src/recipes/nextjs/README.md | 6 +++--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/packages/create/src/recipes/express/README.md b/packages/create/src/recipes/express/README.md index c26b8205f..7f7d35495 100644 --- a/packages/create/src/recipes/express/README.md +++ b/packages/create/src/recipes/express/README.md @@ -2,8 +2,6 @@ This recipe provides a starting point for building an [Express](https://expressjs.com/) application with EdgeDB as the database. -We try to actively monitor and incorporate significant changes from the original "create-app" templates to to ensure developers have access to the latest features and best practices. - ✨ Check out the [`@edgedb/create` package](https://github.com/edgedb/edgedb-js/blob/master/packages/create/README.md) for more information. ## Usage diff --git a/packages/create/src/recipes/nextjs/README.md b/packages/create/src/recipes/nextjs/README.md index 168ae6459..f0604d679 100644 --- a/packages/create/src/recipes/nextjs/README.md +++ b/packages/create/src/recipes/nextjs/README.md @@ -1,4 +1,4 @@ -# NextJS Integration Recipe for EdgeDB +# Next.js Integration Recipe for EdgeDB This recipe provides a starting point for building a [Next.js](https://nextjs.org/) application with EdgeDB as the database. It is based on the official Next.js starter template. @@ -18,7 +18,7 @@ pnpm create @edgedb bun create @edgedb ``` -After running the command, you will be prompted to provide a project name and choose the **"NextJS"** template. You can also specify whether to use EdgeDB Auth, initialize a git repository, and install dependencies. +After running the command, you will be prompted to provide a project name and choose the **"Next.js"** template. You can also specify whether to use EdgeDB Auth, initialize a git repository, and install dependencies. The tool will then create a new directory with the specified name and set up the project. @@ -48,4 +48,4 @@ Run a local version: $ yarn create ``` -Then choose the **"NextJS"** template. +Then choose the **"Next.js"** template.