https://github.com/stevehobbsdev/marvel-api-demo
A React-Redux-powered app to browse characters from the official Marvel API
https://github.com/stevehobbsdev/marvel-api-demo
Last synced: 3 months ago
JSON representation
A React-Redux-powered app to browse characters from the official Marvel API
- Host: GitHub
- URL: https://github.com/stevehobbsdev/marvel-api-demo
- Owner: stevehobbsdev
- Created: 2017-07-17T22:35:41.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-08T12:20:57.000Z (over 7 years ago)
- Last Synced: 2024-12-31T20:16:02.438Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.91 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Marvel API demo
A single-page JavaScript app to demonstrate connectivity with the Marvel API, built using React and Redux. The application is based on the [create-react-app](https://github.com/facebookincubator/create-react-app) starter kit.
## Prerequisites
- NodeJS >= 4.x
- [yarn](https://yarnpkg.com/en/) or npm
- An API key for [the Marvel API](https://developer.marvel.com)
## Getting started
Clone this repository and run `$ yarn install` (or `$ npm install`) from the command line to install dependencies.
## Running the app
Your public API key for the Marvel API must be supplied as an environment variable `REACT_APP_API_KEY` for the application to work.
To start the application on port 3000, run:
`$ REACT_APP_API_KEY= yarn start`
or if using npm:
`$ REACT_APP_API_KEY= npm start`
where `` is your public API key for the Marvel API.
## Testing the app
To run all the associated unit tests using [Jest](https://facebook.github.io/jest/docs/tutorial-react.html), run `$ yarn test` (or `$ npm test`).
## Browser support
The application has been tested on:
- Chrome 59
- Internet Explorer 11
- Microsoft Edge 38
- Firefox 52
- Brave Mobile (Android)
## Preview
