Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Latest commit

 

History

History
134 lines (84 loc) · 2.89 KB

File metadata and controls

134 lines (84 loc) · 2.89 KB

Contributing

These instructions will help you develop and test new features.

Overview

Getting Started
Development Environment
Integrations
Making Changes
Testing

Development Environment

Due to limitations with Vercel, the development server can only be started from the root of the repository.

yarn dev:api

The development server will start on http://localhost:8080.

Integrations

Algolia

Algolia is a search-as-a-service platform that allows end users to filter and search API resources.

Environment Variables

  • ALGOLIA_API_KEY
  • ALGOLIA_APP_ID

Apple Music API

The Apple Music API is used to fetch store playlist data.

Environment Variables

  • APPLE_AUTHKEY_MUSICKIT
  • APPLE_AUTHKEY_MUSICKIT_KEY_ID
  • APPLE_TEAM_ID

Google Analytics

Google Analytics is a web analytics service that tracks and reports website traffic.

KAPI uses the Measurement Protocol for Universal Analytics to track API requests, success responses, and errors.

Environment Variables

  • GA_TRACKING_ID
  • VERCEL_ENV
  • VERCEL_GIT_COMMIT_REF
  • VERCEL_GIT_COMMIT_SHA

Judge.me Product Reviews

Judge.me Product Reviews is a web app that helps e-commerce stores collect and display product and store reviews and other user-generated content.

Environment Variables

  • JUDGEME_API_TOKEN
  • MOCK_POST_REVIEW

Opsgenie

Opsgenie is an on-call and alert management service for software projects.

Its primary use is to dispatch alerts from GitHub.

Shopify

Shopify is an e-commerce platform. Aside from functioning as our commerce backend, it is also our content management system.

Environment Variables

  • SHOPIFY_API_KEY
  • SHOPIFY_API_VERSION
  • SHOPIFY_SHOP_NAME
  • SHOPIFY_PASSWORD

Making Changes

API Endpoints

Directory: api

For more information, see the Vercel Serverless Functions documentation.

Config

Directory: lib/config

Middleware

Directory: lib/middleware

Services

Directory: lib/services

Type Definitions

Directory: lib/types

Utilities

Directory: lib/utils

Testing

Directory: __tests__
Command: yarn test

For more information, see the root package Contributing Guide.