Skip to content

Commit

Permalink
Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
shrikantg199 authored Dec 11, 2023
1 parent 5d725f8 commit a2dce70
Showing 1 changed file with 63 additions and 5 deletions.
68 changes: 63 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,66 @@
# React + Vite
# Amazon Clone Website

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

Currently, two official plugins are available:
This project is an Amazon clone website created using React and Tailwind CSS with the Vite build tool. While the website is not fully responsive, it serves as a demonstration of building a modern e-commerce platform with popular web development technologies.

- [@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
## Technologies Used

- React: A JavaScript library for building user interfaces.
- Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.
- Vite: A fast, opinionated web development build tool that serves as a replacement for Create React App.

## Features

- Product Listing: Display a list of products with relevant information.
- Product Details: Show detailed information about a selected product.
- Shopping Cart: Allow users to add products to a cart and proceed to checkout.
- Responsive Design (Partial): While not fully responsive, some aspects of the design may adapt to different screen sizes.

## Getting Started

1. Clone the repository:

```bash
git clone https://github.com/shrikantg199/amazon-clone.git
```

2. Navigate to the project directory:

```bash
cd amazon-clone
```

3. Install dependencies:

```bash
npm install
```

4. Run the development server:

```bash
npm run dev
```

This will start the development server, and you can view the website by navigating to `http://localhost:3000` in your web browser.

## Usage

- Explore the product listings and click on a product for more details.
- Add products to the shopping cart and proceed to checkout.
- Note: Due to the lack of full responsiveness, the user experience may vary on different devices.

## Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or create a pull request.

## License

This project is licensed under the [MIT License](LICENSE).

## Acknowledgments

Special thanks to the creators of React, Tailwind CSS, and Vite for providing the tools that made this project possible.

Happy coding! 👩‍💻🚀

0 comments on commit a2dce70

Please sign in to comment.