- Do make sure to not put your personal
.env
file under version control. Rungit rm -r --cached .
git add .
and commit to make sure it is removed from your repository clone. - Configure the prisma endpoint in your
.env
file to map to your workspace of else have it point to a custom prisma instance. - If running in production, supply your firebase credentials through the env variables
FIREBASE_CREDS_URL
andFIREBASE_DATABASE_URL
. For local development, put your firebase credentials in a file calledfirebase-creds.json
at the root level.
You need to have the GraphQL CLI installed to bootstrap your GraphQL server using graphql create
:
npm install -g graphql-cli
# 1. Bootstrap GraphQL server in directory `my-app`, based on `typescript-basic` boilerplate
graphql create my-app --boilerplate typescript-basic
# 2. When prompted, deploy the Prisma service to a _public cluster_
# 3. Navigate to the new project
cd my-app
# 4. Start server (runs on http://localhost:4000) and open GraphQL Playground
yarn dev
yarn start
starts GraphQL server onhttp://localhost:4000
yarn dev
starts GraphQL server onhttp://localhost:4000
and opens GraphQL Playgroundyarn playground
opens the GraphQL Playground for theprojects
from.graphqlconfig.yml
yarn prisma <subcommand>
gives access to local version of Prisma CLI (e.g.yarn prisma deploy
)
Note: We recommend that you're using
yarn dev
during development as it will give you access to the GraphQL API or your server (defined by the application schema) as well as to the Prisma API directly (defined by the Prisma database schema). If you're starting the server withyarn start
, you'll only be able to access the API of the application schema.
File name | Description |
---|---|
├── .graphqlconfig.yml |
Configuration file based on graphql-config (e.g. used by GraphQL Playground). |
└── database (directory) |
Contains all files that are related to the Prisma database service |
├── prisma.yml |
The root configuration file for your Prisma database service (docs) |
└── datamodel.graphql |
Defines your data model (written in GraphQL SDL) |
└── src (directory) |
Contains the source files for your GraphQL server |
├── index.ts |
The entry point for your GraphQL server |
├── schema.graphql |
The application schema defining the API exposed to client applications |
└── generated (directory) |
Contains generated files |
├── prisma.ts |
The generated TypeScript bindings for the Prisma GraphQL API |
└── prisma.grapghql |
The Prisma database schema defining the Prisma GraphQL API |
The GraphQL boilerplates are maintained by the GraphQL community, with official support from the Apollo & Graphcool teams.
Your feedback is very helpful, please share your opinion and thoughts! If you have any questions or want to contribute yourself, join the #graphql-boilerplate
channel on our Slack.