Git Product home page Git Product logo

marvel-characters's Introduction

Requirements

Installation

  1. Install Node, Yarn, Redis from links above or via command line
  2. Install Node dependencies
yarn
  1. Set up environment variables
cp .env.example .env

Build and Run

  1. Run Redis server
redis-server
  1. Start Node server
yarn dev
  1. Call APIs via Postman or browser

Test

yarn test

Caching Strategy

  • When there is no cache upon the first API call, all character ids are fetched from the external Marvel API
  • Then they are stored in an object together with a cached date in Redis
{
  "characters": [1, 2, 3],
  "timestamp": "2021-05-16"
}
  • When cache is found upon subsequent API call, all character ids are extracted from Redis, together with the timestamp
  • The timestamp is used to call the external Marvel API by being passed in as modifiedSince to fetch any additional characters that have been added since the cached date

marvel-characters's People

Contributors

yuroitaki avatar

Stargazers

Christopher Chong avatar

Watchers

James Cloos avatar avatar

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.