yashsehgal29 / namaste-mart

Namste Mart

Namste Mart is an e-commerce website built with modern web technologies, offering a seamless shopping experience for users. This README provides an overview of the project, how to set it up, and other relevant information.

Features

• User authentication with Firebase
• Modern UI components with Material-UI and Tailwind CSS
• State management with Redux Toolkit
• Responsive design
• Hot reloading for development
• Easy integration of custom fonts and icons

Getting Started

Prerequisites

Ensure you have the following software installed:

• Node.js (version 14 or higher)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/namste-mart.git
   cd namste-mart

2. Install the dependencies:

   npm install
   # or
   yarn install

Usage

Development

To start the development server with hot reloading:

npm run dev
# or
yarn dev

The application will be available at http://localhost:5173.

Building

To create a production build:

Technologies Used

• React: JavaScript library for building user interfaces
• Vite: Next generation frontend tooling
• Redux Toolkit: State management for modern apps
• Material-UI: React components for faster and easier web development
• Tailwind CSS: Utility-first CSS framework
• Styled Components: Visual primitives for the component age
• Firebase: Backend-as-a-Service (BaaS) for authentication
• React Router: Declarative routing for React
• ESLint: Pluggable JavaScript linter
• Firebase: for backend and database

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature/YourFeature)
3. Commit your changes (git commit -m 'Add YourFeature')
4. Push to the branch (git push origin feature/YourFeature)
5. Create a new Pull Request

License

This README provides a clear and structured overview of your project, making it easier for others to understand and contribute. Be sure to customize the repository URL, contribution guidelines, and license details as per your specific project needs.