diff --git a/breaking-bad-characters/README.md b/breaking-bad-characters/README.md index b80369463..f44212945 100644 --- a/breaking-bad-characters/README.md +++ b/breaking-bad-characters/README.md @@ -1,33 +1,44 @@ -# Breaking Bad Characters - React Application +# ๐Ÿงช Breaking Bad Characters Explorer -## About the Project -A single page web application that uses the breaking bad API to display and filter characters from the show +A sleek, single-page React application that fetches and displays character data from the Breaking Bad universe. Users can easily browse and dynamically filter through their favorite characters using real-time API data. -## Technologies Used +This project is part of the `Web-dev-mini-projects` collection. -- React - - Hooks - - Components -- CSS - - CSS Grid -- Javascript - - Axios - - ES6 -- API - - Breaking Bad API +## โœจ Key Features +* **Dynamic Grid Layout:** Displays character profiles in a highly responsive CSS Grid. +* **Live Filtering:** Instantly search and filter characters by name. +* **API Integration:** Asynchronously fetches character details (like name, nickname, and portrait) from an external endpoint. +## ๐Ÿ› ๏ธ Tech Stack +* **Frontend Framework:** React (Functional Components & Hooks) +* **Styling:** CSS3 (focused on CSS Grid for layout) +* **JavaScript:** ES6+ syntax +* **Data Fetching:** Axios for handling asynchronous HTTP requests -## API Used -Breaking Bad Character API +## ๐Ÿ“ก API Reference +This project relies on the Breaking Bad Character API to populate the user interface. +* **Endpoint Used:** `https://www.breakingbadapi.com/api/characters` -Link : https://www.breakingbadapi.com/api/characters +## ๐Ÿƒโ€โ™‚๏ธ How to Run Locally -## How to use the Project +To get this React application running on your local machine, follow these steps: -1. Download or clone the repository `git clone https://github.com/Ayushparikh-code/Web-dev-mini-projects.git` -2. Go to the directory -3. Open the terminal, and type `npm start` +1. **Clone the repository:** + ```bash + git clone [https://github.com/Ayushparikh-code/Web-dev-mini-projects.git](https://github.com/Ayushparikh-code/Web-dev-mini-projects.git) +Navigate to the directory: +Open your terminal and change into the specific Breaking Bad project folder. +Install dependencies: +Because this project uses React and Axios, you must install the Node modules first: + +Bash +npm install +Start the development server: + +Bash +npm start +The application will automatically compile and open in your default browser at http://localhost:3000 ## Screenshots diff --git a/loremipsum-generator/README.md b/loremipsum-generator/README.md index 09509862c..99b95827c 100644 --- a/loremipsum-generator/README.md +++ b/loremipsum-generator/README.md @@ -1,5 +1,27 @@ -# Loremipsum Generator -## _TIRED OF BORING LOREM IPSUM?_ +# ๐Ÿ“ Lorem Ipsum Generator -- This is a simple Loremipsum Generator generator which is developed using HTML, CSS and JavaScript. -- Just input how many paragraphs you want and it will provide some different lorem ipsum paragraphs. +**TIRED OF BORING LOREM IPSUM?** Welcome to the Lorem Ipsum Generator! This is a simple, fast, and easy-to-use tool built to help developers and designers get fresh placeholder text in seconds. Instead of copying and pasting the same old text, just tell the app how many paragraphs you need, and it will do the rest. + +## โœจ Features + +* **Customizable Output:** Choose exactly how many paragraphs you want to generate. +* **Fresh Text:** Provides different variations of lorem ipsum text. +* **Simple Interface:** Clean, user-friendly design that is easy to navigate. +* **Instant Results:** Generates text instantly right in your web browser. + +## ๐Ÿ› ๏ธ Technologies Used + +This project is built using the core building blocks of the web: + +* **HTML:** For the structure of the web page. +* **CSS:** For the styling and making it look good. +* **JavaScript:** For the logic to generate and display the text. + +## ๐Ÿš€ How to Use + +It is very easy to run this project on your own computer! + +1. **Download the code:** Clone this repository or download the ZIP file. +2. **Open the project:** Find the folder on your computer. +3. **Run it:** Double-click the `index.html` file to open it in your favorite web browser (like Chrome, Firefox, or Edge). +4. **Generate:** Type the number of paragraphs you want into the input box, click the button, and copy your new text! diff --git a/speed-distance-time-calculator/readme.md b/speed-distance-time-calculator/readme.md index f45819b1b..ed56c50e0 100644 --- a/speed-distance-time-calculator/readme.md +++ b/speed-distance-time-calculator/readme.md @@ -1,5 +1,34 @@ -# Welcome ๐Ÿ– to the Speed-Distance-Time Calculator Website -It is a multi pager Speed Distance Time Calculator with simple but user-friendly design. +# โฑ๏ธ Speed-Distance-Time Calculator + +A clean, multi-page web application designed to instantly calculate speed, distance, or time. Featuring a simple and user-friendly interface, this tool provides dedicated calculation pages for each specific metric to ensure a frictionless user experience. + +This project is part of the `Web-dev-mini-projects` collection. + +## โœจ Key Features +* **Multi-Page Architecture:** Dedicated pages tailored specifically for calculating Speed, Time, and Distance individually. +* **Instant Results:** Performs mathematical conversions and calculations in real-time. +* **Intuitive UI:** A straightforward, accessible design that makes navigation and data entry effortless. +* **No Dependencies:** Built entirely with pure web technologies for rapid load times. + +## ๐Ÿ› ๏ธ Tech Stack +* **HTML5:** Semantic structure and multi-page routing. +* **CSS3:** Custom styling for a clean, responsive layout. +* **Vanilla JavaScript:** Mathematical logic and DOM manipulation. + +## ๐Ÿƒโ€โ™‚๏ธ How to Run Locally + +Getting this project running on your machine takes just a few seconds: + +1. **Clone the repository:** + ```bash + git clone [https://github.com/Ayushparikh-code/Web-dev-mini-projects.git](https://github.com/Ayushparikh-code/Web-dev-mini-projects.git) +Navigate to the correct directory: +Open your terminal and change into the specific calculator folder: + +Bash +cd Web-dev-mini-projects/speed-distance-time-calculator +Run the application: +Simply double-click the index.html file to open the Homepage in your default web browser. (Alternatively, use the "Live Server" extension in VS Code for a better development experience). ## Default view of the website HOMEPAGE @@ -25,23 +54,6 @@ Distance Calculator
-### How to get the website on your local machine: - ---- - -- Download or clone the repository - -``` -git clone https://github.com/Ayushparikh-code/Web-dev-mini-projects.git -``` - -- Go to the directory -``` -cd speed-distance-time-calculator -```` - - Run the index.html file and see the results - -
## Happy Coding!