primer / api

A GraphQL API for collecting and accessing data about the Primer Design System

Primer API

Warning: Experimental. Not production ready.

A GraphQL API for collecting and accessing data about the Primer Design System

Data flow

Technology stack

• Apollo Server for running the GraphQL server
• Prisma for defining the data schema
• TypeGraphQL Prisma for generating a GraphQL API from our Prisma schema
• Supabase for hosting the PostgreSQL database

Local development

Set up

1. Clone the repository:

   git clone [email protected]:primer/api.git primer-api
   cd primer-api

2. Run the setup script:

   npm run setup

   This will install and build any necessary dependencies.

3. Create a .env file in the api directory of the repository with a DATABASE_URL variable:

   DATABASE_URL=...

   The DATABASE_URL variable should be set to a connection string for a PostgreSQL database. Ask @colebemis, @langermank, or @mperrotti for the connection string.

Run locally

1. Run the start script:

   npm run start

   This will start the following servers locally:

   • GraphQL API: http://localhost:4000
   • Docs example: http://localhost:3000

Publish schema changes

1. Make changes to the database schema in prisma/schema.prisma

2. Run a migration:

   npm run prisma:migrate

api's Issues

Require auth to mutate data

We should require some form of auth to mutate data in the Primer database.

Deploy GraphQL API

Let's deploy the Primer GraphQL API so people can use it.

Notes

• We should automatically deploy the API to production when new commits are pushed to main
• It would be nice if we could deploy it to https://primer.style/api
• When you visit https://primer.style/api in a browser, it should render an interactive GraphQL API playground