|
1 |
| -# Getting Started with Create React App |
| 1 | +# Breaking Bad Characters - React Application |
2 | 2 |
|
3 |
| -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 3 | +### About the Project |
| 4 | +A single page web application that uses the breaking bad API to show and filter characters from the show |
4 | 5 |
|
5 |
| -## Available Scripts |
| 6 | +### Technologies |
6 | 7 |
|
7 |
| -In the project directory, you can run: |
| 8 | +- React |
| 9 | + - Hooks |
| 10 | + - Components |
| 11 | +- CSS |
| 12 | + - CSS Grid |
| 13 | +- Javascript |
| 14 | + - Axios |
| 15 | + - ES6 |
| 16 | +- API |
| 17 | + - Breaking Bad API |
8 | 18 |
|
9 |
| -### `npm start` |
10 | 19 |
|
11 |
| -Runs the app in the development mode.\ |
12 |
| -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 20 | +### API Used |
| 21 | +Breaking Bad Character API |
13 | 22 |
|
14 |
| -The page will reload if you make edits.\ |
15 |
| -You will also see any lint errors in the console. |
| 23 | +Link : https://www.breakingbadapi.com/api/characters |
16 | 24 |
|
17 |
| -### `npm test` |
| 25 | +### How It Works |
18 | 26 |
|
19 |
| -Launches the test runner in the interactive watch mode.\ |
20 |
| -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 27 | +- Search a recipe in the search input |
| 28 | +- Grabs the recipe information from Edamam API. |
| 29 | +- Information is returned has a JSON object |
| 30 | +- Using React components to structure data into presentational format |
| 31 | +- Using CSS to create visually appealing and user friendly application |
21 | 32 |
|
22 |
| -### `npm run build` |
| 33 | +## Screenshots |
23 | 34 |
|
24 |
| -Builds the app for production to the `build` folder.\ |
25 |
| -It correctly bundles React in production mode and optimizes the build for the best performance. |
| 35 | +<p>Initially, it will show a loader</p> |
26 | 36 |
|
27 |
| -The build is minified and the filenames include the hashes.\ |
28 |
| -Your app is ready to be deployed! |
| 37 | +<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-kp/breaking-bad-characters/Screenshots/ss3.png" /> |
29 | 38 |
|
30 |
| -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 39 | +<p>After 3-4 seconds, it will load all the characters of the show</p> |
31 | 40 |
|
32 |
| -### `npm run eject` |
| 41 | +<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-kp/breaking-bad-characters/Screenshots/ss1.png" /> |
33 | 42 |
|
34 |
| -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 43 | +<p>Clicking on any image, it will show other information like Name, Nickname, Birthday, Occupation, Status...</p> |
35 | 44 |
|
36 |
| -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
| 45 | +<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-kp/breaking-bad-characters/Screenshots/ss2.png" /> |
37 | 46 |
|
38 |
| -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
| 47 | +<p>User can search a particular character by typing his/her name in the search box</p> |
39 | 48 |
|
40 |
| -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
| 49 | +<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-kp/breaking-bad-characters/Screenshots/ss4.png" /> |
41 | 50 |
|
42 |
| -## Learn More |
43 | 51 |
|
44 |
| -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 52 | +## Live Demo |
45 | 53 |
|
46 |
| -To learn React, check out the [React documentation](https://reactjs.org/). |
47 |
| - |
48 |
| -### Code Splitting |
49 |
| - |
50 |
| -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) |
51 |
| - |
52 |
| -### Analyzing the Bundle Size |
53 |
| - |
54 |
| -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) |
55 |
| - |
56 |
| -### Making a Progressive Web App |
57 |
| - |
58 |
| -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) |
59 |
| - |
60 |
| -### Advanced Configuration |
61 |
| - |
62 |
| -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) |
63 |
| - |
64 |
| -### Deployment |
65 |
| - |
66 |
| -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) |
67 |
| - |
68 |
| -### `npm run build` fails to minify |
69 |
| - |
70 |
| -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
| 54 | +<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-kp/breaking-bad-characters/Screenshots/demo.gif" /> |
0 commit comments