https://github.com/rh9891/breakingbad
A React application that utilizes the Breaking Bad API to display and filter the characters from the hit TV show, Breaking Bad.
https://github.com/rh9891/breakingbad
breaking-bad-api css-animations react useeffect-hook usestate-hook
Last synced: 10 months ago
JSON representation
A React application that utilizes the Breaking Bad API to display and filter the characters from the hit TV show, Breaking Bad.
- Host: GitHub
- URL: https://github.com/rh9891/breakingbad
- Owner: rh9891
- Created: 2020-09-24T00:15:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-27T03:52:49.000Z (about 4 years ago)
- Last Synced: 2023-09-24T17:38:29.697Z (over 2 years ago)
- Topics: breaking-bad-api, css-animations, react, useeffect-hook, usestate-hook
- Language: JavaScript
- Homepage: https://breaking-bad-characters-with-react.netlify.app/
- Size: 85.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Breaking Bad
[](https://opensource.org/licenses/MIT)
## Table of Contents
* [Description](#description)
* [User Story](#user-story)
* [Features of the Application](#features-of-the-application)
* [Preview of Breaking Bad](#preview-of-breaking-bad)
* [Links](#links)
* [Installation](#installation)
* [Usage](#usage)
* [Built Using](#built-using)
* [License](#license)
* [Contributing](#contributing)
* [Questions](#questions)
## Description
Breaking Bad is a responsive, semantic React application that utilizes the Breaking Bad API to display and filter the characters from the TV show, Breaking Bad. The application also utilizes useEffect and useState hooks for state management. The application features a grid system to dynamically display the character's pictures and the use of transition/transform in CSS for animation effects and displaying the character's information on the back of the cards.
## User Story
~~~
AS A user
I WANT to search for - and access information about - Breaking Bad characters
SO THAT I can discover more about the cast and show.
~~~
## Features of the Application
~~~
GIVEN a search-based application
WHEN I load the page
THEN a grid of Breaking Bad characters will render.
WHEN I input a character's name into the search bar
THEN I will be able to filter the characters based on my query.
~~~
## Preview of Breaking Bad
The following animation demonstrates the complete application functionality:
To download the above video file of the application functionality, you may do so [here](https://github.com/rh9891/BreakingBad/blob/master/assets/videos/breakingBadFunctionalityPreview.mp4).
## Links
- [Deployed Application](https://breaking-bad-characters-with-react.netlify.app/)
- [Github Repository](https://github.com/rh9891/BreakingBad)
## Installation
The application requires the following dependencies and/or package managers:
~~~
$ npm install axios
~~~
When downloaded, the application requires the input of `npm install` into the command line interface in order to download the contents of the `package.json`.
## Usage
The application can be initiated by inputting `npm start` into the command line interface and running the application on `localhost: 3000`.
## Built Using
Listed below are the frameworks, libraries, and guides that made building this application possible:
* [Breaking Bad API](https://breakingbadapi.com/)
* [React](https://reactjs.org/docs/getting-started.html)
* [React Hooks](https://reactjs.org/docs/hooks-intro.html)
* [Traversy Media Tutorials](https://www.traversymedia.com/)
## License
The MIT License (MIT)
Copyright (c) 2020 Romie Hecdivert
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## Contributing
If you would like to contribute to this repository, please contact me via [Github](https://github.com/rh9891).
## Questions
If you have any questions, comments, or issues regarding this application, please do not hesitate to contact me via [Github](https://github.com/rh9891).