Code Monkey home page Code Monkey logo

tmdb-api's Introduction

๐ŸŽฌ TMDB API

Build StatusCode Coverage

A GraphQL API wrapper for The Movie DB built with Apollo Data Sources.

๐Ÿ› ๏ธ Setup

Install dependencies by running yarn, then create a new file in the root directory named .env. You'll need to get an API key from The Movie DB in order to run any queries. For more information, please read the Movie DB docs. Additionally, if you want to track usage metrics for your API, you'll need to get an API key from Apollo Graph Manager. For instructions on how to do that, please read the Apollo Graph Manager docs. In your new .env file, copy + paste the following and replace the text following the = sign with your newly create API keys.

MOVIE_DB_API_V3_KEY=<insert your movie database v3 api key here>
# OR
MOVIE_DB_API_V4_KEY=<insert your movie database v4 api key here>

APOLLO_KEY=<insert your apollo studio api key here>

Once that's done, you can now start up a development server using yarn start. Once the development server is listening, you can pull up a GraphQL Playground by visiting one of the following URL:

Netlify: http://localhost:1337/.netlify/functions/tmdb-api

๐Ÿ•น๏ธ Demo

You can try out the API using the GraphQL Playground hosted at https://tmdb-api.saeris.io/.netlify/functions/tmdb-api

๐Ÿงช Testing

Testing is provided via jest and is pre-configured to run with codecov as well. While tests for this project are far from complete, they can be found under src/__TEST__ and follow a naming format of [filename].spec.ts. Additionally, this project uses eslint, typescript, and prettier, all three of which are automatically run on each commit via husky + lint-staged. To manually lint and test, use the following commands:

Lint:

yarn lint

Typecheck:

yarn typecheck

Test and watch for changes:

yarn test:watch

Lint + Typecheck + Test:

yarn test

๐Ÿฅ‚ License

Released under the MIT license.

tmdb-api's People

Contributors

saeris avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

tmdb-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.