Bug Reports and Feature Requests Code General Prerequisites Dev Setup Helpful commands Legal

Bug Reports and Feature Requests

If you have found a bug or have a feature request then please create an issue in this repository (please search first in case a similar issue already exists).

Code

General Prerequisites

Install NodeJS, latest LTS is recommended

Install pnpm (for installing dependencies)

Install yarn@1 (for building the project before deploy)

Install zx (for running project scripts)

Install docker (for bundling the project before deploy and local server)

Install the AWS CLI (for deploying on AWS)

Install the AWS CDK (for deploying on AWS)

Verify installation:

shell
node -v && pnpm --version && yarn --version && zx --version && docker --version && aws --version && cdk --version

Dev Setup

graphql
# clone the repo
git clone https://github.com/maoosi/prisma-appsync.git

# install dependencies
pnpm install

# run local dev playground
pnpm dev

Helpful commands

`pnpm install`	Install project dependencies.
`pnpm test`	Run all unit tests and e2e tests.
`pnpm build`	Build the entire `prisma-appsync` library.
`pnpm dev`	Automatically generates a `playground` folder (unless already existing), plus run a local GraphQL + AWS AppSync server pointing to the `playground` folder. This creates an ideal local dev environment that emulates Prisma-AppSync running on AWS locally. Everything inside `playground` is pointing local source packages.

Legal

By submitting your code to the Prisma-AppSync project, you are granting the project maintainers a right to use that code and provide it to others under the BSD 2-Clause License attached to the project. You are also certifying that you wrote it, and that you are allowed to license it to us.