Skip to content

Commit 4c61a2c

Browse files
committed
feat(simpsons-quotes) : Create and update Readme .MD
1 parent 32f5ac2 commit 4c61a2c

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

Simpsons-Quotes/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Random Simpsons Quotes
2+
3+
4+
**A fun project that displays random quotes from The Simpsons using HTML, CSS, and JavaScript.**
5+
This project allows users to fetch random quotes from the popular animated show "The Simpsons."
6+
![Alt text](capture.png )
7+
### Features
8+
- **Random Quote Generation**: Users can click a button to fetch a new quote from The Simpsons.
9+
- **Dynamic Content**: The quote and associated character image are displayed instantly upon fetching.
10+
- **Loader Animation**: A visual loading animation is displayed while the quote is being fetched.
11+
- **Error Handling**: Displays an error message for network issues or when the API call fails.
12+
13+
## Description
14+
This project provides a simple interface for users to interact with an API that returns quotes from "The Simpsons." Users can click a button to retrieve a random quote, which is then displayed along with an image of the character who said it.
15+
16+
The project utilizes HTML for structure, CSS for styling and animation, and JavaScript to handle the logic of fetching quotes from the API and updating the UI dynamically.
17+
18+
## Prerequisites
19+
Before running this project, you should have a basic understanding of the following technologies:
20+
- **HTML**: Used for structuring the user interface of the quote generator.
21+
- **CSS**: Used to style the interface and provide a visually appealing layout.
22+
- **JavaScript**: Handles the logic for fetching quotes from the API and updating the display based on user interactions.
23+
24+
## How to Use
25+
1. Open the `index.html` file in your web browser.
26+
2. Click the button labeled "Get a New Quote" to fetch a random quote.
27+
3. The quote and the associated character's image will be displayed on the screen.
28+
4. If there is an error while fetching the quote, an error message will be shown.
29+
30+
## Installation
31+
To run this project locally:
32+
1. Clone the repository or download the files.
33+
2. Open `index.html` in any web browser.
34+
35+
## Installing Instructions
36+
Explain how to set up and run your package/script on the user's local machine. Include steps like:
37+
1. Clone the repository:
38+
```bash
39+
git clone https://github.com/king04aman/All-In-One-Javascript-Projects.git
40+
```
41+
2. Navigate to the project directory:
42+
```bash
43+
cd All-In-One-Javascript-Projects/Temperature-convertor
44+
```
45+
3. Open `index.html` in a web browser.
46+
47+
## Author
48+
- [Basset Gaëtan](https://github.com/gbasset)

0 commit comments

Comments
 (0)