Skip to content

Commit 3cd0580

Browse files
Update README.md
1 parent 574807a commit 3cd0580

File tree

1 file changed

+27
-55
lines changed

1 file changed

+27
-55
lines changed

image-finder-app/README.md

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,42 @@
1-
# Getting Started with Create React App
1+
# Image Finder - React Application
22

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 PixaBay API to display the images according to user search.
45

5-
## Available Scripts
6+
## Technologies Used
67

7-
In the project directory, you can run:
8+
- React
9+
- Hooks
10+
- Components
11+
- CSS
12+
- Javascript
13+
- Axios
14+
- ES6
15+
- API
16+
- MaterialUI
17+
818

9-
### `npm start`
19+
## API Used
20+
PixaBay API
1021

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
22+
Link : https://pixabay.com/api/
1323

14-
The page will reload if you make edits.\
15-
You will also see any lint errors in the console.
24+
## How to use the Project
1625

17-
### `npm test`
26+
1. Download or clone the repository `git clone https://github.com/Ayushparikh-code/Web-dev-mini-projects.git`
27+
2. Go to the directory
28+
3. Open the terminal, and type `npm start`
1829

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.
2130

22-
### `npm run build`
31+
## Screenshots
2332

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.
33+
Initial UI looks like:
34+
<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-khushi/image-finder-app/Screenshots/ss1.png" />
2635

27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
36+
After user search for a image:
2937

30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
38+
<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-khushi/image-finder-app/Screenshots/ss2.png" />
3139

32-
### `npm run eject`
3340

34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
41+
<img src="https://github.com/khushi-purwar/Web-dev-mini-projects/blob/dev-khushi/image-finder-app/Screenshots/ss3.png" />
3542

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.
37-
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.
39-
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.
41-
42-
## Learn More
43-
44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
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)

0 commit comments

Comments
 (0)