92bondstreet/marvel

🦸 Marvel Characters portfolio

MARVEL

Marvel Characters portfolio

🐣 Introduction

Very - very very - minimalist portfolio of Marvel Characters based on Marvel API

💻 Live demo

🏗️ Installation

❯ git clone git@github.com:92bondstreet/marvel.git
❯ cd marvel

Note:

• Bootstrapped with create-react-app 3.0.1
• Based on React Hooks (at least React 16.8)
• Yarn is the package manager
• Hosted by Docker if needed

/client Configuration (.env)

REACT_APP_MARVEL_PROXY_API

Base url of the proxy server api

/server Configuration (.env)

NODE_ENV

Determine the way to host the client files generated by create-react-app

MARVEL_PUBLIC_KEY required

the Marvel Comics API public key

MARVEL_PRIVATE_KEY required

the Marvel Comics API private key

🕹️ Usage

## sandbox for dev purpose
## will start the client and server side in containers
## Before create at least server/.env with the Marvel keys
❯ make sandbox

without docker

❯ make install
## create client/.env and server/.env files with the right env variables
❯ make sandbox-local

📦 Distribution and Packaging

## build and start a ready-production web application with docker
❯ make build

without docker

❯ make build-local

📱 Features

• 🦸 Display a grid of characters (name, thumbnail, number of comics and series)
• 📄 Paginate and/or select a given page
• 🗃️ Loading placeholder during characters fetching
• 💯 Set limit per page
• 🔤 Order by name or modification date

🚀 Deploy

❯ make deploy