README.md

Graphcool Templates 📗

Use Graphcool templates to quickly pull in predefined functionality into your own Graphcool service.

Overview

Officially supported templates

We maintain a number of officially supported templates:

• auth: Templates for different authentication mechanisms, such as email-password or facebook.
• messaging: Templates to quickly integrate with different messaging services, such as mailgun (emails), pusher (push notifications) or twilio (SMS).

Outdated templates

Notice that the outdated templates are not officially supported. Right now, most of the templates inside the outdated directory are not working when used with the graphcool-framework add-template command!

Contributions

Contributions are highly welcome 💚 if you'd like to add a new template, you can get inspiration from the help wanted label, or suggest your own template!

Adding templates to your service

There are two ways how you can use a template in your service:

1. Manually download and copy the code from a template directory in this repository.
2. Use the add-template command from the CLI.

Option 1: Manually adding templates

The process of adding a template to a Graphcool service involves several steps. You're basically merging your local service definition with the service definition of the template you want to use. In the end, you end up with only one graphcool.yml as well as only one types.graphql.

Adding a template manually:

1. Download the folder that contains the service definition of the template you want to use.
2. Copy that folder into the root directory of your Graphcool service.
3. Copy over the contents from the template's graphcool.yml into the graphcool.yml of your own service. Be sure to adjust any file references, e.g. source files that contain code for functions, if necessary.
4. Copy over the contents from the template's types.graphql into the types.graphql of your own service.
5. Deploy your changes with graphcool deploy.

Option 2: Adding templates with the CLI

The add-template command in the Graphcool CLI basically automates the process of manually adding templates.

Official templates can be added by providing their relative path in this repository, e.g. for the email-password-template:

graphcool-framework add-template auth/email-password

To install your own templates, you can provide the path to a GitHub repository, too:

graphcool-framework add-template graphcool/templates/auth/email-password

When merging the template's graphcool.yml and types.graphql files with the ones from your local service definition, the CLI will only add the contents from the template files into your local files as comments. So you need to explicitly uncomment the parts form the template files that you actually want to use in your service.

The process for using the CLI to add a template thus looks as follows:

1. Use the add-template <path> CLI command and specify the <path> which points to the template's directory in this repository.
2. Uncomment the lines in graphcool.yml and types.graphql.
3. Deploy your changes with graphcool deploy.

Contributors

A big thank you to all contributors and supporters of this repository 💚

Help & Community

Say hello in our Slack or visit the Graphcool Forum if you run into issues or have questions. We love talking to you!