diff --git a/Dictionary/README.md b/Dictionary/README.md index ed780f8ee..5edc057ae 100644 --- a/Dictionary/README.md +++ b/Dictionary/README.md @@ -1,14 +1,40 @@ # Wordictionary -[Wordictionary](https://yash-barjatya.github.io/Dictionary/ "Wordictionary: A word dictionary website") : A _Word dictionary_ , where you can search for ***meaning***, ***pronounciation***, ***example*** (use of that word in sentences) of millions of words and also ***bookmark*** the words for future references. +[Wordictionary](https://yash-barjatya.github.io/Dictionary/ "Wordictionary: A word dictionary website") -- - - - - It is written in : +**Welcome to Wordictionary!** This is a powerful and interactive word dictionary web application. Whether you are looking for the exact meaning, pronunciation, or an example of a word used in a sentence, Wordictionary has you covered. It even lets you save words for later! + +> **Note:** For the best user experience, it is highly recommended to view this application on a desktop or laptop. + +## โœจ Features + +* **Comprehensive Search:** Get the meaning and real-world sentence examples for millions of words. +* **Phonetic Pronunciations:** Learn exactly how to pronounce the words you search for. +* **Bookmark System:** easily save and bookmark difficult or interesting words for quick future reference. +* **Smart Recent Searches:** Hover your mouse over recent searches to instantly get a quick definition without having to reload or click! + +## ๐Ÿ› ๏ธ Tech Stack + +This project is built purely with core frontend web technologies: + +* **HTML:** To structure the layout of the dictionary and search inputs. +* **CSS:** To style the application and create smooth hover effects. +* **JavaScript:** To fetch dictionary data, handle the bookmarking logic, and manage recent searches. + +## ๐Ÿš€ How to Run It on Your Computer + +It is incredibly easy to start searching for words locally. Just follow these steps: + +**1. Download the code:** Open your terminal and clone the repository: +```bash +git clone [https://github.com/atharvachavan289-gif/Web-dev-mini-projects.git](https://github.com/atharvachavan289-gif/Web-dev-mini-projects.git) +2. Open the project folder: Navigate into the main folder and then open the Dictionary directory: -* _HTML_ -* _CSS_ -* _JS_ +Bash +cd Web-dev-mini-projects +cd Dictionary +3. Run the app: Find the index.html file inside the folder and double-click it. It will open right up in your default web browser (like Chrome, Firefox, or Edge). - - - - 1. **Search word and get not only the meaning of the word but also learn about its phonetic.** 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/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!