diff --git a/packages/create/src/recipes/express/README.md b/packages/create/src/recipes/express/README.md new file mode 100644 index 000000000..7f7d35495 --- /dev/null +++ b/packages/create/src/recipes/express/README.md @@ -0,0 +1,49 @@ +# Express Integration Recipe for EdgeDB + +This recipe provides a starting point for building an [Express](https://expressjs.com/) application with EdgeDB as the database. + +✨ 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..f0604d679 --- /dev/null +++ b/packages/create/src/recipes/nextjs/README.md @@ -0,0 +1,51 @@ +# 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. + +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 **"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. + +## 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 **"Next.js"** 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..84a94fa57 --- /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.