Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.4 KB

README.md

File metadata and controls

70 lines (50 loc) · 2.4 KB

The Open Movie DB GraphQL NestJS Example

Nest Logo

NPM Version Package License CI Status Coverage

A GraphQL API built with NestJS that wraps The Movie Database (TMDB) API to provide movie and TV show data through a GraphQL interface.

Features

  • GraphQL API built with NestJS and Apollo Server
  • Integration with TMDB API for movie and TV show data
  • Type-safe GraphQL schema with TypeScript
  • Environment configuration with validation
  • Modular architecture following NestJS best practices
  • Comprehensive test coverage with Jest
  • Code quality tools (ESLint, Prettier)
  • CI/CD pipeline with GitHub Actions

Prerequisites

  • Node.js (v18+)
  • Yarn package manager
  • TMDB API key (Get one here)

Installation

  1. Install Node.js (v18 or higher) from nodejs.org

  2. Install Yarn package manager (v4):

    corepack enable
    corepack prepare [email protected] --activate
  3. Generate an API token from TMDB API

  4. Clone the repository:

    git clone https://github.com/AlexMachin1997/TheOpenMovieDB-GraphQL-Example.git
    cd TheOpenMovieDB-GraphQL-Example
  5. Install dependencies:

    yarn install
  6. Create a .env file in the root directory and add your TMDB API token:

    TMDB_API_TOKEN=your_api_token_here
    
  7. Start the development server:

    yarn start:dev

The GraphQL playground will be available at http://localhost:3000/graphql