Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aayush2761 authored Jun 12, 2024
1 parent 6e34ebe commit aebb16d
Showing 1 changed file with 91 additions and 5 deletions.
96 changes: 91 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,94 @@
# React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:
# Currency Converter

A simple and responsive currency converter application built using HTML, CSS, JavaScript, and React, configured with Vite. This application allows users to convert amounts from one currency to another and provides a user-friendly interface for seamless conversion.

![Currency Converter]

## Features

- Real-time currency conversion
- Swap button to quickly exchange the "From" and "To" currencies
- User-friendly and responsive design
- Easy to extend and maintain

## Technologies Used

- HTML
- CSS
- JavaScript
- React
- Vite

## Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Make sure you have the following installed on your local machine:

- Node.js
- npm (Node Package Manager)

### Installation

1. Clone the repository to your local machine:

```bash
git clone https://github.com/aayush2761/currencyConverter.git
```

2. Navigate to the project directory:

```bash
cd currency-converter
```

3. Install the dependencies:

```bash
npm install
```

### Running the Application

To run the application in development mode, use the following command:

```bash
npm run dev
```

Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

### Building for Production

To build the app for production, use the following command:

```bash
npm run build
```

This will create an optimized production build in the `dist` folder.

### Previewing the Production Build

To preview the production build locally, use the following command:

```bash
npm run serve
```

Open [http://localhost:5000](http://localhost:5000) to view the production build in the browser.

## Usage

1. Enter the amount you want to convert in the "From" field.
2. Select the currency type from the dropdown menu.
3. Select the target currency type in the "To" field.
4. Click the "Convert" button to see the conversion result.
5. Use the "Swap" button to switch the "From" and "To" currencies quickly.

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

0 comments on commit aebb16d

Please sign in to comment.