Skip to content

Commit

Permalink
Add README.md for the @edgedb/create package (#849)
Browse files Browse the repository at this point in the history
  • Loading branch information
beerose authored Feb 6, 2024
1 parent 9383b7a commit 3a35839
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions packages/create/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# `@edgedb/create`: Project scaffolding for EdgeDB-backed applications

The `@edgedb/create` package provides a starting point for various frameworks with everything you need to start building an EdgeDB-backed application. We aim to follow the same conventions as the original "create-app" templates, but with EdgeDB as the database. There are a few different templates to choose from, including: Next.js, Remix, Express, Node HTTP Server.

Important points to note:

- **Upstream changes:** 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.
- **Support for major options:** While we strive to support the major options offered by the upstream "create-apps", we might not cover every possible configuration or permutation due to the vast scope of possibilities.
- **EdgeDB CLI installation:** For users who do not have the EdgeDB CLI installed, we automatically install it using our typical installation procedure.

## 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 a 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.

## Contributing

If you want to add a new template, please open an issue first. We are open to new ideas and would love to hear your feedback.

### Development

Install dependencies in the root directory:

```bash
$ yarn
```

Navigate into `packages/create`:

```bash
$ cd packages/create
```

Build `@edgedb/generate`

```bash
$ yarn build
```

Run a local version:

```bash
$ yarn create
```

### Testing

```bash
$ yarn test
```

0 comments on commit 3a35839

Please sign in to comment.