Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kamrul2006/k-tech-ui

It is a tech hunting web app. Where Users can post products, view their submissions, update product details, and manage their content seamlessly........
https://github.com/kamrul2006/k-tech-ui

firebase npm-package react react-query react-router tailwindcss

Last synced: 1 day ago
JSON representation

It is a tech hunting web app. Where Users can post products, view their submissions, update product details, and manage their content seamlessly........

Awesome Lists containing this project

README

        

# K-Tech Logo K-Tech:
**Discover, Share, and Vote on Innovative Products**

[Live Site URL](https://k-tech-ltd.web.app): **https://k-tech-ltd.web.app**

---
## 🚀 Overview

K-Tech UI is a dynamic web platform designed for seamless product management, interactive user engagement, and efficient content moderation. It offers a user-friendly interface for product submissions, a powerful review system for moderators, and premium membership benefits for enhanced access.

## 📌 Features

- **User-Friendly Product Management**: Users can post products, view submissions, update details, and manage their content effortlessly.
- **Dynamic Product Review Queue**: Moderators can review, approve, reject, or feature products with ease.
- **Reported Content Management**: Handle reported products with detailed views and removal options for inappropriate content.
- **Membership Benefits**: Subscribers can post unlimited products, bypassing normal user restrictions.
- **Interactive Home Layout**: Includes sections like Featured Products, Explore Categories, FAQs, and more for an engaging experience.

## 📂 Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Environment Variables](#environment-variables)
- [Dependencies](#dependencies)
- [Development](#development)
- [License](#license)

## 🛠 Installation

1. **Clone the repository**
```sh
git clone https://github.com/your-repo/k-tech-ui.git
cd k-tech-ui
```

2. **Install dependencies**
```sh
npm install
```

3. **Set up the environment variables**
Create a `.env` file in the root directory and configure the required variables (see the next section).

4. **Start the development server**
```sh
npm run dev
```

## 🔧 Environment Variables

Create a `.env` file in the root directory with the following keys (replace with your actual values):

```plaintext
DB_USER=your_database_user
DB_PASS=your_database_password
JWT_SECRET=your_jwt_secret
STRIPE_SECRET=your_stripe_secret_key
```

âš  **Important:** Never expose sensitive credentials in public repositories. Use `.gitignore` to prevent committing the `.env` file.

## 📦 Dependencies

The project uses the following technologies:

### Frontend

- **React** (^18.3.1)
- **React Router DOM** (^7.1.1)
- **TailwindCSS** (^3.4.17)
- **Framer Motion** (^12.0.5)
- **Axios** (^1.7.9)
- **Recharts** (^2.15.0)

### Backend & Security

- **Firebase** (^11.1.0)
- **jsonwebtoken (JWT)** (^9.0.2)
- **Stripe API** (^5.5.0)

### Development Tools

- **Vite** (^6.0.5)
- **ESLint** (^9.17.0)
- **DaisyUI** (^4.12.23)

## â–¶ Usage

- **Start Development Server**
```sh
npm run dev
```

- **Build for Production**
```sh
npm run build
```

- **Lint the Code**
```sh
npm run lint
```

- **Preview the Production Build**
```sh
npm run preview
```

## 🛠 Development

To contribute to this project:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make changes and commit (`git commit -m "Added new feature"`).
4. Push to the branch (`git push origin feature-branch`).
5. Open a Pull Request.

## 📜 License

This project is licensed under the **MIT License**.

---

### ✨ Enjoy Building with K-Tech UI! 🚀
```

This README is well-structured, informative, and **secure** by keeping sensitive data private. Let me know if you need any modifications! 🚀